DescribeBackups
该接口用于查询集群的备份信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 否 | DescribeBackups |
系统规定参数,取值:DescribeBackups。 |
DBClusterId | String | 是 | pc-bpxxxxxxx |
POLARDB集群ID。 |
EndTime | String | 是 | 2019-07-27T15:00Z |
查询结束时间,需晚于查询开始时间。格式: |
StartTime | String | 是 | 2019-07-26T15:00Z |
查询开始时间。格式: |
BackupId | String | 否 | 42395xxxx |
备份ID。 |
BackupStatus | String | 否 | Success |
备份状态,取值:
|
BackupMode | String | 否 | Manual |
备份类型,取值:
|
PageSize | Integer | 否 | 30 |
每页记录数,取值:
默认值:30。 |
PageNumber | Integer | 否 | 1 |
页码,大于0且不超过Integer的最大值。 默认值:1。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | E22FB172-F0AB-42FF-A6D0-115065D64971 |
请求ID。 |
TotalRecordCount | String | 2 |
总记录数。 |
PageNumber | String | 1 |
页码。 |
PageRecordCount | String | 2 |
本页记录数。 |
Items | Array |
由备份组成的列表。 |
|
BackupId | String | 123123123 |
备份ID。 |
DBClusterId | String | pc-bpxxxxxxx |
POLARDB集群ID。 |
BackupStatus | String | Success |
备份状态,取值:
|
BackupStartTime | String | 2020-01-03T04:39:36Z |
本次备份开始时间(UTC时间)。 |
BackupEndTime | String | 2020-01-03T04:39:51Z |
本次备份结束时间(UTC时间)。 |
BackupType | String | FullBackup |
备份种类,仅支持全量备份,取值:FullBackup。 |
BackupMode | String | Manual |
备份类型,取值:
|
BackupMethod | String | Snapshot |
备份方式,仅支持快照备份,取值:Snapshot 。 |
BackupSetSize | String | 123123123 |
备份文件大小,单位:Byte。 说明 删除该快照备份后释放的空间远小于该备份文件的大小,因为快照之间有共享的数据块。
|
ConsistentTime | String | 123123123 |
一致性快照时间点,格式为时间戳。 |
示例
请求示例
http(s)://[Endpoint]/?Action=DescribeBackups
&DBClusterId=pc-bpxxxxxxx
&EndTime=2019-07-27T15:00Z
&StartTime=2019-07-26T15:00Z
&<公共请求参数>
正常返回示例
XML
格式
<Items>
<Backup>
<StoreStatus>Disabled</StoreStatus>
<ConsistentTime>123123123</ConsistentTime>
<BackupType>FullBackup</BackupType>
<BackupSetSize>123123123</BackupSetSize>
<BackupEndTime>2020-01-03T04:39:51Z</BackupEndTime>
<BackupMethod>Snapshot</BackupMethod>
<BackupMode>Automated</BackupMode>
<BackupStatus>Success</BackupStatus>
<DBClusterId>pc-bpxxxxxxx</DBClusterId>
<BackupStartTime>2020-01-03T04:39:36Z</BackupStartTime>
<BackupId>123123123</BackupId>
</Backup>
</Items>
<PageNumber>1</PageNumber>
<TotalRecordCount>1</TotalRecordCount>
<RequestId>A95DEB2C-C07F-4C9E-B71E-B4F6C7E8E1BF</RequestId>
<PageRecordCount>1</PageRecordCount>
JSON
格式
{
"Items": {
"Backup": [
{
"StoreStatus": "Disabled",
"ConsistentTime": 123123123,
"BackupType": "FullBackup",
"BackupSetSize": 123123123,
"BackupEndTime": "2020-01-03T04:39:51Z",
"BackupMethod": "Snapshot",
"BackupMode": "Automated",
"BackupStatus": "Success",
"DBClusterId": "pc-bpxxxxxxx",
"BackupStartTime": "2020-01-03T04:39:36Z",
"BackupId": 123123123
}
]
},
"PageNumber": 1,
"TotalRecordCount": 1,
"RequestId": "A95DEB2C-C07F-4C9E-B71E-B4F6C7E8E1BF",
"PageRecordCount": 1
}
错误码
访问错误中心查看更多错误码。
版权声明
本文仅代表作者观点,不代表本站立场。
本文系作者授权发表,未经许可,不得转载。
评论