调用DescribeBackups接口查询PolarDB集群的备份信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 否 | DescribeBackups |
系统规定参数，取值为DescribeBackups。 |
| DBClusterId | String | 是 | pc-**************** |
集群ID。 |
| EndTime | String | 是 | 2020-11-16T00:00Z |
查询结束时间，查询结束时间需晚于开始时间，格式为 |
| StartTime | String | 是 | 2020-11-14T00:00Z |
查询开始时间，格式为 |
| BackupId | String | 否 | 11111111 |
备份ID。 |
| BackupStatus | String | 否 | Success |
备份状态，取值范围如下：
|
| BackupMode | String | 否 | Automated |
备份模式，取值范围如下：
|
| PageSize | Integer | 否 | 30 |
每页记录数，取值范围如下：
默认值为30。 |
| PageNumber | Integer | 否 | 1 |
页码，取值范围为大于0但不超过Integer最大值的整数，默认值为1。 |
返回数据
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Items | Array of Backup |
备份集详情。 |
|
| Backup | |||
| BackupEndTime | String | 2020-11-15T07:30:20Z |
本次备份结束时间（UTC时间）。 |
| BackupId | String | 61******* |
备份ID。 |
| BackupMethod | String | Snapshot |
数据备份方法，仅支持快照备份，取值固定为Snapshot 。 |
| BackupMode | String | Automated |
备份模式，取值范围如下：
|
| BackupSetSize | String | 4639948800 |
备份文件大小，单位为Byte。
说明 因为快照之间存在共享数据块，因此删除目标快照备份后释放的空间会远小于该备份文件的大小。更多详情，请参见
备份功能FAQ。 |
| BackupStartTime | String | 2020-11-15T07:30:05Z |
本次备份开始时间（UTC时间）。 |
| BackupStatus | String | Success |
备份状态，取值范围如下：
|
| BackupType | String | FullBackup |
备份类型，仅支持全量备份，取值固定为FullBackup。 |
| BackupsLevel | String | Level-1 |
备份集级别，取值范围如下：
|
| ConsistentTime | String | 1605425407 |
一致性快照的时间点，格式为Unix时间戳，单位为秒。 |
| DBClusterId | String | pc-**************** |
集群ID。 |
| IsAvail | String | 0 |
备份集是否可用，取值范围如下：
|
| PageNumber | String | 1 |
页码。 |
| PageRecordCount | String | 1 |
本页记录数。 |
| RequestId | String | 24A1990B-4F6E-482B-B8CB-75C612****** |
请求ID。 |
| TotalRecordCount | String | 1 |
总记录数。 |
示例
请求示例
http(s)://polardb.aliyuncs.com/?Action=DescribeBackups
&DBClusterId=pc-****************
&EndTime=2020-11-16T00:00Z
&StartTime=2020-11-14T00:00Z
&<公共请求参数>正常返回示例
XML 格式
<DescribeBackupsResponse>
<TotalRecordCount>1</TotalRecordCount>
<PageRecordCount>1</PageRecordCount>
<RequestId>24A1990B-4F6E-482B-B8CB-75C612******</RequestId>
<PageNumber>1</PageNumber>
<Items>
<Backup>
<BackupMethod>Snapshot</BackupMethod>
<BackupMode>Automated</BackupMode>
<BackupsLevel>Level-1</BackupsLevel>
<DBClusterId>pc-****************</DBClusterId>
<BackupId>111111111</BackupId>
<IsAvail>1</IsAvail>
<BackupSetSize>4639948800</BackupSetSize>
<StoreStatus>Disabled</StoreStatus>
<BackupEndTime>2020-11-15T07:30:20Z</BackupEndTime>
<BackupStartTime>2020-11-15T07:30:05Z</BackupStartTime>
<ConsistentTime>1605425407</ConsistentTime>
<BackupType>FullBackup</BackupType>
<BackupStatus>Success</BackupStatus>
</Backup>
</Items>
</DescribeBackupsResponse>JSON 格式
{
"TotalRecordCount": 1,
"PageRecordCount": 1,
"RequestId": "24A1990B-4F6E-482B-B8CB-75C612******",
"PageNumber": 1,
"Items": {
"Backup": [
{
"BackupMethod": "Snapshot",
"BackupMode": "Automated",
"BackupsLevel": "Level-1",
"DBClusterId": "pc-****************",
"BackupId": 111111111,
"IsAvail": 1,
"BackupSetSize": 4639948800,
"StoreStatus": "Disabled",
"BackupEndTime": "2020-11-15T07:30:20Z",
"BackupStartTime": "2020-11-15T07:30:05Z",
"ConsistentTime": 1605425407,
"BackupType": "FullBackup",
"BackupStatus": "Success"
}
]
}
}错误码
访问错误中心查看更多错误码。
