调用DescribeBackups接口查看集群的备份列表。

调试

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

请求参数

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

系统规定参数,取值:

DescribeBackups。

DBClusterId String am-bp1xxxxxxxx47

实例ID。

EndTime String 2011-06-15T16:00Z

查询结束时间,需要大于查询开始时间,格式:yyyy-MM-ddTHH:mmZ。

StartTime String 2011-06-01T16:00Z

查询开始时间,格式:yyyy-MM-ddTHH:mmZ。

BackupId String 327329803

备份集ID。

PageSize Integer 30

每页记录数,取值:

  • 30;
  • 50;
  • 100

默认值:30。

PageNumber Integer 1

页码,取值:大于0且不超过Integer的最大值。

默认值:1。

返回数据

名称 类型 示例值 描述
Items Array of Backup

备份集列表。

Backup
BackupEndTime String 2011-05-30T03:29:00Z

本次备份结束时间,格式:YYYY-MM-DDTHH:mm:ssZ。

BackupId String 327329803

备份集ID。

BackupMethod String Snapshot

备份方法。

Snapshot:快照备份

BackupSize Integer 2167808

备份文件大小,单位:Byte。

BackupStartTime String 2011-05-30T03:29:00Z

本次备份开始时间,格式:YYYY-MM-DDTHH:mm:ssZ。

BackupType String FullBackup

备份类型。取值:

  • FullBackup:全量备份。
  • IncrementalBackup:增量备份。
DBClusterId String am-bp1xxxxxxxx47

实例ID。

PageNumber String 10

页码。

PageSize String 30

本页备份集个数。

RequestId String 1AD222E9-E606-4A42-BF6D-8A4442913CEF

请求ID。

TotalCount String 300

总记录数。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeBackups
&DBClusterId=am-bp1xxxxxxxx47
&EndTime=2011-06-15T16:00Z
&StartTime=2011-06-01T16:00Z
&<公共请求参数>

正常返回示例

XML格式

<TotalCount>300</TotalCount>
<RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>
<PageSize>30</PageSize>
<PageNumber>10</PageNumber>
<Items>
    <Backup>
        <BackupMethod>Snapshot</BackupMethod>
        <BackupEndTime>2011-05-30T03:29:00Z</BackupEndTime>
        <BackupSize>2167808</BackupSize>
        <DBClusterId>am-bp1xxxxxxxx47	</DBClusterId>
        <BackupStartTime>2011-05-30T03:29:00Z</BackupStartTime>
        <BackupId>327329803</BackupId>
        <BackupType>FullBackup</BackupType>
    </Backup>
</Items>

JSON格式

{
    "TotalCount": 300,
    "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
    "PageSize": 30,
    "PageNumber": 10,
    "Items": {
        "Backup": {
            "BackupMethod": "Snapshot",
            "BackupEndTime": "2011-05-30T03:29:00Z",
            "BackupSize": 2167808,
            "DBClusterId": "am-bp1xxxxxxxx47",
            "BackupStartTime": "2011-05-30T03:29:00Z",
            "BackupId": 327329803,
            "BackupType": "FullBackup"
        }
    }
}

错误码

HttpCode 错误码 错误信息 描述
404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. 您指定的 DBClusterId 不存在,请确认 DBClusterId 值是否正确。

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