You need to enable JavaScript to run this app.
导航
云数据库 PostgreSQL 版
  • 文档首页
    • /
  • 云数据库 PostgreSQL 版

DescribeBackups

最近更新时间：2023.12.14 10:51:50

首次发布时间：2023.11.15 22:39:51

我的收藏

调用 DescribeBackups 接口查询备份列表。

请求类型

同步请求。

请求参数

名称类型是否必选示例值描述
InstanceIdString是postgres-21a3333b****实例 ID。
BackupIdString否20231101-021****_20231101-101****备份 ID。

BackupStartTime

String

否

2023-10-19T06:20:06.000Z

备份创建最早时间，格式为 yyyy-MM-ddTHH:mm:ss.sssZ（UTC 时间）。

说明

以备份开始时间为准。

BackupEndTime

String

否

2023-10-19T06:20:08.000Z

备份创建最晚时间，格式为 yyyy-MM-ddTHH:mm:ss.sssZ（UTC 时间）。

说明

以备份开始时间为准。

BackupStatus

String

否

Success

备份状态，取值：

  • Success：成功。
  • Failed：失败。
  • Running：执行中。

BackupType

String

否

Full

备份类型，取值：

  • Full：全量备份（默认）。
  • Increment：增量备份。
PageNumberInteger否1当前页查询偏移量，默认值为 1。
PageSizeInteger否10每页记录数，取值应大于 0 且不超过 1000，默认值为 10。

返回参数

名称类型示例值描述
TotalInt321备份总数。
BackupsArray of BackupObject请参见返回示例。备份列表。关于 Backups 的详细信息，请参见数据结构。

请求示例

POST /?Action=DescribeBackups&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host: rds.volcengineapi.com
X-Date: 20231002T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_postgresql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****
{
        "InstanceId": "postgres-da8f12d3****"
}

返回示例

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "202308041100439000B4A38D7086052659",
        "Action": "DescribeBackups",
        "Version": "2022-01-01",
        "Service": "rds_postgresql",
        "Region": "cn-beijing"
    },
    "Result": {
        "Backups": [
            {
                "BackupEndTime": "2023-11-15T12:43:08.000Z",
                "BackupFileName": "20231115-024906F_20231115-204305I",
                "BackupFileSize": 17195278,
                "BackupId": "20231115-024906F_20231115-204305I",
                "BackupProgress": 100,
                "BackupStartTime": "2023-11-15T12:43:05.000Z",
                "BackupStatus": "Success",
                "BackupType": "Increment",
                "CreateType": "System",
                "InstanceInfo": {
                    "ChargeDetail": {
                        "AutoRenew": false,
                        "ChargeEndTime": "",
                        "ChargeStartTime": "2023-09-11T06:43:34.000Z",
                        "ChargeStatus": "Normal",
                        "ChargeType": "PostPaid",
                        "Number": 1,
                        "OverdueReclaimTime": "",
                        "OverdueTime": "",
                        "Period": 1,
                        "PeriodUnit": "Month"
                    },
                    "DBEngineVersion": "PostgreSQL_12",
                    "InstanceId": "postgres-da8f12d3****",
                    "InstanceName": "测试实例",
                    "InstanceStatus": "Running",
                    "InstanceType": "HA",
                    "Memory": 2,
                    "Nodes": [
                        {
                            "InstanceId": "postgres-da8f12d3****",
                            "NodeId": "postgres-da8f12d3****",
                            "NodeSpec": "rds.postgres.1c2g",
                            "NodeType": "Primary",
                            "ZoneId": "cn-beijing-b"
                        },
                        {
                            "InstanceId": "postgres-da8f12d3****",
                            "NodeId": "postgres-da8f12d3****-fkoh",
                            "NodeSpec": "rds.postgres.1c2g",
                            "NodeType": "Secondary",
                            "ZoneId": "cn-beijing-a"
                        }
                    ],
                    "ProjectName": "rds-pg",
                    "StorageSpace": 20,
                    "StorageType": "LocalSSD",
                    "SubnetId": "subnet-30uhx4w39n75s7r2qr0lq****",
                    "VCPU": 1,
                    "VpcId": "vpc-2gdgzrrl5icjk50ztyz6b****",
                    "ZoneId": "cn-chongqing-b"
                }
        ],
        "Total": 1
    }
}