调用DescribeDetachedBackups接口,查询已被释放的PolarDB集群中备份集详情。
调用本接口时,PolarDB集群需处于已释放状态,且集群释放时选择永久保留全部备份或永久保留最后一个备份(删除前自动备份)。若集群释放后所保留的备份集全部被主动删除,则此接口也无法再查询到该集群。
说明 您可以调用
DescribeDBClusterAttribute接口查询集群状态。
DescribeDBClusterAttribute接口查询集群状态。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 否 | DescribeDetachedBackups |
系统规定参数,取值为DescribeDetachedBackups。 |
DBClusterId | String | 是 | pc-**************** |
集群ID。 |
EndTime | String | 是 | 2020-05-14T00:00Z |
查询结束时间,查询结束时间需晚于开始时间,格式为 |
StartTime | String | 是 | 2020-05-01T00:00Z |
查询开始时间,格式为 |
BackupId | String | 否 | 111111111 |
备份ID。 |
BackupStatus | String | 否 | Success |
备份状态,取值范围如下:
|
BackupMode | String | 否 | Manual |
备份模式,取值范围如下:
|
PageSize | Integer | 否 | 30 |
每页记录数,取值范围如下:
默认值为30。 |
PageNumber | Integer | 否 | 1 |
页码,取值范围为大于0但不超过Integer最大值的整数,默认值为1。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Items | Array of Backup |
备份集详情。 |
|
Backup | |||
BackupEndTime | String | 2020-05-12T03:25:55Z |
本次备份结束时间(UTC时间)。 |
BackupId | String | 111111111 |
备份ID。 |
BackupMethod | String | Snapshot |
数据备份方法,仅支持快照备份,取值固定为Snapshot 。 |
BackupMode | String | Manual |
备份模式,取值范围如下:
|
BackupSetSize | String | 7251056 |
备份文件大小,单位为Byte。
说明 因为快照之间存在共享数据块,因此删除目标快照备份后释放的空间会远小于该备份文件的大小。
|
BackupStartTime | String | 2020-05-12T03:25:44Z |
本次备份开始时间(UTC时间)。 |
BackupStatus | String | Success |
备份状态,取值范围如下:
|
BackupType | String | FullBackup |
备份类型,仅支持全量备份,取值固定为FullBackup。 |
BackupsLevel | String | Level-2 |
备份集级别,取值范围如下:
|
ConsistentTime | String | 1589253947 |
一致性快照的时间点,格式为Unix时间戳,单位为秒。 |
DBClusterId | String | pc-************** |
集群ID。 |
IsAvail | String | 1 |
备份集是否可用,取值范围如下:
|
StoreStatus | String | Disabled |
是否允许删除备份集,取值范围如下:
|
PageNumber | String | 1 |
页码。 |
PageRecordCount | String | 1 |
本页记录数。 |
RequestId | String | 717B2382-BB14-4DCB-BBC2-32DBE0****** |
请求ID。 |
TotalRecordCount | String | 1 |
总记录数。 |
示例
请求示例
http(s)://polardb.aliyuncs.com/?Action=DescribeDetachedBackups
&DBClusterId=pc-****************
&EndTime=2020-05-14T00:00Z
&StartTime=2020-05-01T00:00Z
&<公共请求参数>
正常返回示例
XML
格式
<DescribeDetachedBackupsResponse>
<TotalRecordCount>1</TotalRecordCount>
<PageRecordCount>1</PageRecordCount>
<RequestId>717B2382-BB14-4DCB-BBC2-32DBE0******</RequestId>
<PageNumber>1</PageNumber>
<Items>
<Backup>
<BackupMethod>Snapshot</BackupMethod>
<BackupMode>Manual</BackupMode>
<BackupsLevel>Level-2</BackupsLevel>
<DBClusterId>pc-***************</DBClusterId>
<BackupId>62*******</BackupId>
<IsAvail>1</IsAvail>
<BackupSetSize>7251056</BackupSetSize>
<StoreStatus>Enabled</StoreStatus>
<BackupEndTime>2020-05-12T03:25:55Z</BackupEndTime>
<BackupStartTime>2020-05-12T03:25:44Z</BackupStartTime>
<ConsistentTime>1589253947</ConsistentTime>
<BackupType>FullBackup</BackupType>
<BackupStatus>Success</BackupStatus>
</Backup>
</Items>
</DescribeDetachedBackupsResponse>
JSON
格式
{
"TotalRecordCount": 1,
"PageRecordCount": 1,
"RequestId": "717B2382-BB14-4DCB-BBC2-32DBE0******",
"PageNumber": 1,
"Items": {
"Backup": [
{
"BackupMethod": "Snapshot",
"BackupMode": "Manual",
"BackupsLevel": "Level-2",
"DBClusterId": "pc-***************",
"BackupId": "62*******",
"IsAvail": 1,
"BackupSetSize": 7251056,
"StoreStatus": "Enabled",
"BackupEndTime": "2020-05-12T03:25:55Z",
"BackupStartTime": "2020-05-12T03:25:44Z",
"ConsistentTime": 1589253947,
"BackupType": "FullBackup",
"BackupStatus": "Success"
}
]
}
}
错误码
访问错误中心查看更多错误码。