调用DescribeBackups接口查询PolarDB集群的备份信息。

调试

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

请求参数

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

系统规定参数，取值为DescribeBackups。
DBClusterId String 是 pc-****************

PolarDB集群ID。
EndTime String 是 2020-05-02T00:00Z

查询结束时间（UTC时间），格式为YYYY-MM-DDThh:mmZ。

说明 查询结束时间需晚于开始时间。
StartTime String 是 2020-05-01T00:00Z

查询开始时间（UTC时间），格式为YYYY-MM-DDThh:mmZ。

BackupId String 否 61*******

备份ID。
BackupStatus String 否 Success

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

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

备份类型，取值范围如下：

  • Automated：系统自动备份。
  • Manual：手动备份。
PageSize Integer 否 30

每页记录数，默认值为30，取值范围如下：

  • 30。
  • 50。
  • 100。
PageNumber Integer 否 1

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

返回数据

名称 类型 示例值 描述
Items Array

备份集详情。
Backup
BackupEndTime String 2020-05-01T22:56:43Z

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

BackupId String 61*******

备份ID。
BackupMethod String Snapshot

备份方式，仅支持快照备份，取值为Snapshot 。
BackupMode String Automated

备份类型，取值范围如下：

  • Automated：系统自动备份。
  • Manual：手动备份。
BackupSetSize String 154920107

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

说明 因为快照之间存在共享数据块，因此删除目标快照备份后释放的空间会远小于该备份文件的大小。
BackupStartTime String 2020-05-01T22:56:28Z

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

BackupStatus String Success

备份状态，取值范围为：

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

备份种类，仅支持全量备份，取值为FullBackup。
BackupsLevel String Level-2

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

  • Level-1：一级备份。
  • Level-2：二级备份。
ConsistentTime String 1589418586

一致性快照的时间点，格式为Unix时间戳。
DBClusterId String pc-****************

集群ID。
IsAvail String 0

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

  • 0：不可用。
  • 1：可用。
StoreStatus String Disabled

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

  • Enabled：允许删除。
  • Disabled：不允许删除。
PageNumber String 1

页码。
PageRecordCount String 1

本页记录数。
RequestId String EAF5BFA9-78FD-486B-9C76-DF292******

请求ID。
TotalRecordCount String 1

总记录数。

示例

请求示例

http(s)://polardb.aliyuncs.com/?Action=DescribeBackups
&DBClusterId=pc-****************
&EndTime=2020-05-02T00:00Z
&StartTime=2020-05-01T00:00Z
&<公共请求参数>

正常返回示例

XML 格式 

<TotalRecordCount>1</TotalRecordCount>
<PageRecordCount>1</PageRecordCount>
<RequestId>EAF5BFA9-78FD-486B-9C76-DF292******</RequestId>
<PageNumber>1</PageNumber>
<Items>
    <Backup>
        <BackupMethod>Snapshot</BackupMethod>
        <BackupMode>Automated</BackupMode>
        <BackupsLevel>Level-2</BackupsLevel>
        <DBClusterId>pc-****************</DBClusterId>
        <BackupId>61*******</BackupId>
        <IsAvail>1</IsAvail>
        <BackupSetSize>154920107</BackupSetSize>
        <StoreStatus>Disabled</StoreStatus>
        <BackupEndTime>2020-05-01T22:56:43Z</BackupEndTime>
        <BackupStartTime>2020-05-01T22:56:28Z</BackupStartTime>
        <ConsistentTime>1588373790</ConsistentTime>
        <BackupType>FullBackup</BackupType>
        <BackupStatus>Success</BackupStatus>
    </Backup>
</Items>

JSON 格式 

{
	"TotalRecordCount": 1,
	"PageRecordCount": 1,
	"RequestId": "EAF5BFA9-78FD-486B-9C76-DF292******",
	"PageNumber": 1,
	"Items": {
		"Backup": [
			{
				"BackupMethod": "Snapshot",
				"BackupMode": "Automated",
				"BackupsLevel": "Level-2",
				"DBClusterId": "pc-****************",
				"BackupId": "61*******",
				"IsAvail": 1,
				"BackupSetSize": 154920107,
				"StoreStatus": "Disabled",
				"BackupEndTime": "2020-05-01T22:56:43Z",
				"BackupStartTime": "2020-05-01T22:56:28Z",
				"ConsistentTime": 1588373790,
				"BackupType": "FullBackup",
				"BackupStatus": "Success"
			}
		]
	}
}

错误码

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