DescribeDetachedBackups--云数据库 PostgreSQL 版-火山引擎

文档中心

立即注册

导航

DescribeDetachedBackups

最近更新时间：2024.12.13 12:00:08首次发布时间：2023.11.15 22:39:51

调用 DescribeDetachedBackups 接口查询已删除实例备份。

请求类型

同步请求。

请求参数

参数	类型	是否必选	示例值	描述
BackupId	String	否	20231016-024****	备份 ID。
InstanceId	String	否	postgres-5704170c****	实例 ID。说明无默认值。不传该字段时返回其他参数所限定的查询条件下所有备份。
InstanceName	String	否	测试实例	实例名称。说明无默认值。不传该字段时返回其他参数所限定的查询条件下所有备份。
BackupStartTime	String	否	2022-01-01T10:10:10.000Z	备份创建最早时间。以备份开始时间为准。格式为 `yyyy-MM-ddTHH:mm:ss.sssZ`（UTC 时间）。说明无默认值。不传该字段时返回其他参数所限定的查询条件下所有备份。
BackupEndTime	String	否	2022-01-01T10:10:10.000Z	备份创建最晚时间。以备份开始时间为准。格式为 `yyyy-MM-ddTHH:mm:ss.sssZ`（UTC 时间）。说明无默认值。不传该字段时返回其他参数所限定的查询条件下所有备份。
ProjectName	String	否	Test	实例所属的项目。说明无默认值。不传该字段时返回其他参数所限定的查询条件下所有备份。
BackupStatus	String	否	Success	备份状态。可不设置，默认取值为 `Success`，即查询状态为成功的备份。
BackupType	String	否	Full	备份类型。可不设置，默认值取值为 `Full`，即查询全量备份。
PageNumber	Integer	否	1	当前页查询偏移量，默认值为 1。
PageSize	Integer	否	10	每页记录数，取值应大于 0 且不超过 1000，默认值为 10。

返回参数

参数	类型	示例值	描述
Total	Integer	1	备份总数。
Backups	Object[]	请参见返回示例。	备份列表。

示例

请求示例

POST /?Action=DescribeDetachedBackups&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host: open.volcengineapi.com
X-Date: 20231002T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_postgresql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****
{
    "BackupId": "20231018-211218F",
    "InstanceId": "postgres-5704170c****",
    "InstanceName": "测试实例",
    "BackupStartTime": "2023-10-18T13:12:18.000Z",
    "BackupEndTime": "2023-10-18T13:17:47.000Z",
    "BackupType": "Full"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2023101821494419338B706183F9C58CA9",
        "Action": "DescribeDetachedBackups",
        "Version": "2022-01-01",
        "Service": "rds_postgresql",
        "Region": "cn-beijing"
    },
    "Result": {
        "Backups": [
            {
                "BackupEndTime": "2023-10-18T13:17:47.000Z",
                "BackupFileName": "",
                "BackupFileSize": 67509779278,
                "BackupId": "20231018-211218F",
                "BackupProgress": 0,
                "BackupStartTime": "2023-10-18T13:12:18.000Z",
                "BackupStatus": "Success",
                "BackupType": "Full",
                "CreateType": "System",
                "InstanceInfo": {
                    "ChargeDetail": {
                        "AutoRenew": false,
                        "ChargeEndTime": "",
                        "ChargeStartTime": "",
                        "ChargeStatus": "Normal",
                        "ChargeType": "PostPaid",
                        "Number": 0,
                        "OverdueReclaimTime": "",
                        "OverdueTime": "",
                        "Period": 0,
                        "PeriodUnit": "Month"
                    },
                    "DBEngineVersion": "PostgreSQL_12",
                    "InstanceId": "postgres-5704170c****",
                    "InstanceName": "测试实例",
                    "InstanceStatus": "Deleted",
                    "InstanceType": "HA",
                    "Memory": 8,
                    "Nodes": [
                        {
                            "InstanceId": "postgres-5704170c****",
                            "NodeId": "postgres-5704170c****",
                            "NodeSpec": "rds.postgres.1c2g",
                            "NodeType": "Primary",
                            "ZoneId": "cn-beijing-c"
                        },
                        {
                            "InstanceId": "postgres-5704170c****",
                            "NodeId": "postgres-5704170c****-zgqy",
                            "NodeSpec": "rds.postgres.1c2g",
                            "NodeType": "Secondary",
                            "ZoneId": "cn-beijing-a"
                        },
                        {
                            "InstanceId": "postgres-5704170c****",
                            "NodeId": "postgres-5704170c****-ro2341",
                            "NodeSpec": "rds.postgres.1c2g",
                            "NodeType": "ReadOnly",
                            "ZoneId": "cn-beijing-b"
                        }
                    ],
                    "ProjectName": "default",
                    "StorageSpace": 100,
                    "StorageType": "LocalSSD",
                    "StorageUse": 100,
                    "SubnetId": "subnet-3jhi4ozzmj6dc3pncmejx****",
                    "VCPU": 4,
                    "VpcId": "vpc-2gdku6nvnp1xc50ztz0py****"
                }
            }
        ],
        "Total": 1
    }
}