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