调用DescribeDetachedBackups接口，查询已被释放的PolarDB集群中备份集详情。

调用本接口时，PolarDB集群需处于已释放状态，且集群释放时选择永久保留全部备份或永久保留最后一个备份（删除前自动备份）。若集群释放后所保留的备份集全部被主动删除，则此接口也无法再查询到该集群。

说明 您可以调用DescribeDBClusterAttribute接口查询集群状态。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 DescribeDetachedBackups

系统规定参数。取值：DescribeDetachedBackups。
DBClusterId String 是 pc-****************

集群ID。
BackupId String 否 111111111

备份ID。
BackupStatus String 否 Success

备份状态，取值范围如下：

  • Success：备份完成
  • Failed：备份失败
BackupMode String 否 Manual

备份模式，取值范围如下：

  • Automated：系统自动备份
  • Manual：手动备份
BackupRegion String 否 cn-hangzhou

跨地域备份的目的地域。

说明 当前仅PolarDB MySQL版支持该参数。
StartTime String 是 2020-05-01T00:00Z

查询开始时间，格式为YYYY-MM-DDThh:mmZ（UTC时间）。
EndTime String 是 2020-05-14T00:00Z

查询结束时间，查询结束时间需晚于开始时间，格式为YYYY-MM-DDThh:mmZ（UTC时间）。
PageSize Integer 否 30

每页记录数，取值范围如下：

  • 30
  • 50
  • 100

默认值为30。
PageNumber Integer 否 1

页码，取值范围为大于0但不超过Integer最大值的整数，默认值为1。

返回数据

名称 类型 示例值 描述
TotalRecordCount String 50

总记录数。
PageRecordCount String 15

本页记录数。
RequestId String 717B2382-BB14-4DCB-BBC2-32DBE0******

请求ID。
PageNumber String 1

页码。
Items Array of Backup

备份集详情。
Backup
BackupSetSize String 7251056

备份文件大小，单位为Byte。

说明 因为快照之间存在共享数据块，因此删除目标快照备份后释放的空间会远小于该备份文件的大小。
ConsistentTime String 1589253947

一致性快照的时间点，格式为Unix时间戳，单位为秒。
StoreStatus String Disabled

是否允许删除备份集，取值范围如下：

  • Enabled：允许删除
  • Disabled：不允许删除
BackupStatus String Success

备份状态，取值范围如下：

  • Success：备份完成
  • Failed：备份失败
BackupType String FullBackup

备份类型，仅支持全量备份，取值固定为FullBackup。
BackupStartTime String 2020-05-12T03:25:44Z

本次备份开始时间（UTC时间）。
IsAvail String 1

备份集是否可用，取值范围如下：

  • 0：不可用
  • 1：可用
BackupEndTime String 2020-05-12T03:25:55Z

本次备份结束时间（UTC时间）。
BackupId String 111111111

备份ID。
DBClusterId String pc-**************

集群ID。
BackupsLevel String Level-2

备份集级别，取值范围如下：

  • Level-1：一级备份
  • Level-2：二级备份
BackupMode String Manual

备份模式，取值范围如下：

  • Automated：系统自动备份
  • Manual：手动备份
BackupMethod String Snapshot

数据备份方法，仅支持快照备份，取值固定为Snapshot 。

示例

请求示例

http(s)://polardb.aliyuncs.com/?Action=DescribeDetachedBackups
&DBClusterId=pc-****************
&BackupId=111111111
&BackupStatus=Success
&BackupMode=Manual
&BackupRegion=cn-hangzhou
&StartTime=2020-05-01T00:00Z
&EndTime=2020-05-14T00:00Z
&PageSize=30
&PageNumber=1
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDetachedBackupsResponse>
    <TotalRecordCount>50</TotalRecordCount>
    <PageRecordCount>15</PageRecordCount>
    <RequestId>717B2382-BB14-4DCB-BBC2-32DBE0******</RequestId>
    <PageNumber>1</PageNumber>
    <Items>
        <BackupSetSize>7251056</BackupSetSize>
        <ConsistentTime>1589253947</ConsistentTime>
        <StoreStatus>Disabled</StoreStatus>
        <BackupStatus>Success</BackupStatus>
        <BackupType>FullBackup</BackupType>
        <BackupStartTime>2020-05-12T03:25:44Z</BackupStartTime>
        <IsAvail>1</IsAvail>
        <BackupEndTime>2020-05-12T03:25:55Z</BackupEndTime>
        <BackupId>111111111</BackupId>
        <DBClusterId>pc-**************</DBClusterId>
        <BackupsLevel>Level-2</BackupsLevel>
        <BackupMode>Manual</BackupMode>
        <BackupMethod>Snapshot</BackupMethod>
    </Items>
</DescribeDetachedBackupsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalRecordCount" : "50",
  "PageRecordCount" : "15",
  "RequestId" : "717B2382-BB14-4DCB-BBC2-32DBE0******",
  "PageNumber" : "1",
  "Items" : [ {
    "BackupSetSize" : "7251056",
    "ConsistentTime" : "1589253947",
    "StoreStatus" : "Disabled",
    "BackupStatus" : "Success",
    "BackupType" : "FullBackup",
    "BackupStartTime" : "2020-05-12T03:25:44Z",
    "IsAvail" : "1",
    "BackupEndTime" : "2020-05-12T03:25:55Z",
    "BackupId" : "111111111",
    "DBClusterId" : "pc-**************",
    "BackupsLevel" : "Level-2",
    "BackupMode" : "Manual",
    "BackupMethod" : "Snapshot"
  } ]
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidDBClusterId.Malformed The specified parameter DBClusterId is not valid. 指定的参数DBClusterId无效
400 InvalidBackupStatus.Malformed The specified parameter BackupStatus is not valid. 指定的参数BackupStatus无效
400 InvalidBackupMode.Malformed The specified parameter BackupMode is not valid. 指定的参数BackupMode无效
400 InvalidStartTime.Malformed The specified parameter StartTime is not valid. 指定的参数StartTime无效
400 InvalidEndTime.Malformed The specified parameter EndTime is not valid. 指定的参数EndTime无效
404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. 当前的记录中不存在提供的DBClusterId。

访问错误中心查看更多错误码。