云数据库 PostgreSQL
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 云数据库 PostgreSQL > API 文档 > 备份与恢复相关接口 > 查询备份统计信息

查询备份统计信息

最近更新时间：2024-03-12 01:44:13

我的收藏

本页目录：

1. 接口描述

接口请求域名： postgres.tencentcloudapi.com 。

本接口(DescribeBackupSummaries)用于查询实例备份的统计信息，返回以实例为维度的备份个数、占用容量等信息（容量单位为字节）。

默认接口请求频率限制：1000次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeBackupSummaries。
Version 是 String 公共参数，本接口取值：2017-03-12。
Region 是 String 公共参数，详见产品支持的 地域列表。
Limit 否 Integer 每页显示数量，取值范围为1-100，默认为返回10条。
示例值：10
Offset 否 Integer 数据偏移量，从0开始。
示例值：0
Filters.N 否 Array of Filter 按照一个或者多个过滤条件进行查询，目前支持的过滤条件有：
db-instance-id：按照实例ID过滤，类型为string。
db-instance-name：按照实例名过滤，类型为string。
db-instance-ip：按照实例私有网络IP地址过滤，类型为string。
OrderBy 否 String 排序字段，支持TotalBackupSize,LogBackupSize,ManualBaseBackupSize,AutoBaseBackupSize。
示例值：TotalBackupSize
OrderByType 否 String 排序方式，包括升序：asc，降序：desc。
示例值：asc

3. 输出参数

参数名称 类型 描述
BackupSummarySet Array of BackupSummary 备份统计信息列表。
TotalCount Integer 查询到的所有备份信息数量。
示例值：10
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询备份统计信息

输入示例

POST / HTTP/1.1
Host: postgres.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBackupSummaries
<公共请求参数>

{
    "Limit": 20,
    "Offset": 0,
    "OrderByType": "desc"
}

输出示例

{
    "Response": {
        "BackupSummarySet": [
            {
                "AutoBaseBackupCount": 3,
                "AutoBaseBackupSize": 3535342436352,
                "DBInstanceId": "postgres-lsw5y0bp",
                "LogBackupCount": 2,
                "LogBackupSize": 167792640,
                "ManualBaseBackupCount": 1,
                "ManualBaseBackupSize": 1178447478784,
                "TotalBackupCount": 6,
                "TotalBackupSize": 4713957707776
            }
        ],
        "RequestId": "3929dd3a-d95d-4ec2-ae69-a98317ce24fa",
        "TotalCount": 10
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

错误码 描述
FailedOperation.DatabaseAccessError 管控元数据库访问失败，请稍后重试。如果持续不成功，请联系客服进行处理。
FailedOperation.DatabaseAffectedError 数据操作失败，请联系客服进行处理。
FailedOperation.FailedOperationError 操作失败，请稍后重试。
InvalidParameterValue.InvalidParameterValueError 参数值有误。
OperationDenied.CamDeniedError 当前操作被限制。
ResourceNotFound.InstanceNotFoundError 实例不存在。
中国站