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

说明 备份集的状态BackupStatus必须是Success,才能用于恢复。

调试

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

请求参数

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

系统规定参数。取值:DescribeBackups

DBInstanceId String rm-uf6wjk5xxxxxxx

实例ID。

BackupId String 327329803

备份集ID。

BackupStatus String Success

备份集状态。取值:

  • Success:已完成备份
  • Failed:备份失败
BackupMode String Automated

备份模式,取值:

  • Automated:系统自动备份
  • Manual:手动备份
StartTime String 2011-06-01T16:00Z

查询开始时间。格式:yyyy-MM-ddTHH:mmZ(UTC时间)。

EndTime String 2011-06-15T16:00Z

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

PageSize Integer 30

每页记录数,取值:

  • 30
  • 50
  • 100

默认值:30

PageNumber Integer 1

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

默认值:1

BackupType String FullBackup

备份类型,取值:

  • FullBackup:全量备份
  • IncrementalBackup:增量备份

返回数据

名称 类型 示例值 描述
RequestId String 1A6D328C-84B8-40DC-BF49-6C73984D7494

请求ID。

TotalEcsSnapshotSize Long 0

实例的快照链大小,单位:字节(Byte)。

PageRecordCount String 30

本页备份集个数。

TotalRecordCount String 100

总记录数。

PageNumber String 1

页码。

Items Array of Backup

备份集列表。

Backup
StorageClass String 0

备份集的存储介质,取值:

  • 0:常规存储
  • 1:归档存储
Encryption String {}

备份集的加密信息。

BackupStatus String Success

备份集状态。

StoreStatus String Disabled

该数据备份是否可删除,取值:

  • Enabled:可删除
  • Disabled:不可删除
ConsistentTime Long 1576506856

备份集的一致性时间点。返回值为时间戳。

说明 仅MySQL 5.6返回本参数,其他版本返回0。
BackupType String FullBackup

备份类型,返回值:

  • FullBackup:全量备份
  • IncrementalBackup:增量备份
CopyOnlyBackup String 0

备份模式,分为常规备份模式(支持全量和增量恢复)和仅复制模式(仅支持全量恢复),取值:

  • 0:常规备份模式
  • 1:仅复制模式
    说明 仅SQL Server返回此参数。
BackupEndTime String 2019-02-13T12:20:00Z

本次备份结束时间。格式:yyyy-MM-ddTHH:mmZ(UTC时间)。

MetaStatus String OK

库表恢复的备份集状态,取值:

  • OK:正常。
  • LARGE:表数量过多,不能用于库表恢复。
  • EMPTY:备份失败的备份集。
说明 空串表示未开通库表恢复的备份集。
BackupInitiator String System

备份任务的发起者。取值:

  • System:系统自动发起
  • User:用户手动发起
BackupIntranetDownloadURL String http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/xxxxx

内网下载地址,若当前不可下载,则返回空值。

说明 例如:备份方式为快照备份的SQL Server实例会返回空值。
BackupMethod String Physical

备份方式,取值:

  • Logical:逻辑备份
  • Physical:物理备份
  • Snapshot:快照备份
BackupStartTime String 2019-02-03T12:20:00Z

本次备份开始时间。格式:yyyy-MM-ddTHH:mmZ(UTC时间)。

BackupDownloadURL String http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/xxxxx

公网下载地址,若当前不可下载,则返回空值。

说明 例如:备份方式为快照备份的SQL Server实例会返回空值。
IsAvail Integer 1

备份集是否可用,取值:

  • 0:不可用
  • 1:可用
BackupId String 321020562

备份集ID。

HostInstanceID String 5882781

产生备份集的实例编号,用于区分该备份集产生于主实例或备实例。

BackupSize Long 2167808

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

BackupMode String Automated

备份模式,取值:

  • Automated:系统自动备份
  • Manual:手动备份
DBInstanceId String rm-uf6wjk5xxxxxxx

实例ID。

Checksum String 1835830439**********

校验和,采用CRC64算法。

BackupDownloadLinkByDB Array of BackupDownloadLinkByDB

单库备份下载链接。

BackupDownloadLinkByDB
IntranetDownloadLink String https://cn-hangzhou-internal.bak.rds.aliyuncs.com/custins53664665/hins18676859_2021072909473127987849.zip?Expires=*****&dbList=tb1

内网下载链接地址。

DataBase String dbs

数据库名称。

DownloadLink String https://cn-hangzhou.bak.rds.aliyuncs.com/custins53664665/hins18676859_2021072909473127987849.zip?Expires=*****&dbList=tb1

下载链接地址。

示例

请求示例

http(s)://rds.aliyuncs.com/?Action=DescribeBackups
&DBInstanceId=rm-uf6wjk5xxxxxxx
&<公共请求参数>

正常返回示例

XML格式

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

<DescribeBackupsResponse>
    <TotalRecordCount>100</TotalRecordCount>
    <TotalEcsSnapshotSize>0</TotalEcsSnapshotSize>
    <PageRecordCount>30</PageRecordCount>
    <RequestId>1A6D328C-84B8-40DC-BF49-6C73984D7494</RequestId>
    <PageNumber>1</PageNumber>
    <Items>
        <Backup>
            <BackupMethod>Physical</BackupMethod>
            <BackupInitiator>System</BackupInitiator>
            <StorageClass>0</StorageClass>
            <BackupIntranetDownloadURL>http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/xxxxx</BackupIntranetDownloadURL>
            <BackupSize>2167808</BackupSize>
            <BackupMode>Automated</BackupMode>
            <BackupId>321020562</BackupId>
            <IsAvail>1</IsAvail>
            <Encryption>{}</Encryption>
            <HostInstanceID>5882781</HostInstanceID>
            <StoreStatus>Disabled</StoreStatus>
            <BackupDownloadURL>http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/xxxxx</BackupDownloadURL>
            <DBInstanceId>rm-uf6wjk5xxxxxxx</DBInstanceId>
            <CopyOnlyBackup>0</CopyOnlyBackup>
            <BackupEndTime>2019-02-13T12:20:00Z</BackupEndTime>
            <ConsistentTime>1576506856</ConsistentTime>
            <BackupStartTime>2019-02-03T12:20:00Z</BackupStartTime>
            <MetaStatus>OK</MetaStatus>
            <BackupType>FullBackup</BackupType>
            <BackupStatus>Success</BackupStatus>
            <BackupDownloadLinkByDB>
                <BackupDownloadLinkByDB>
                    <DownloadLink>https://cn-hangzhou.bak.rds.aliyuncs.com/custins53664665/hins18676859_2021072909473127987849.zip?Expires=*****&amp;dbList=tb1</DownloadLink>
                    <IntranetDownloadLink>https://cn-hangzhou-internal.bak.rds.aliyuncs.com/custins53664665/hins18676859_2021072909473127987849.zip?Expires=*****&amp;dbList=tb1</IntranetDownloadLink>
                    <DataBase>dbs</DataBase>
                </BackupDownloadLinkByDB>
            </BackupDownloadLinkByDB>
        </Backup>
    </Items>
</DescribeBackupsResponse>

JSON格式

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

{
  "DescribeBackupsResponse" : {
    "TotalRecordCount" : 100,
    "TotalEcsSnapshotSize" : 0,
    "PageRecordCount" : 30,
    "RequestId" : "1A6D328C-84B8-40DC-BF49-6C73984D7494",
    "PageNumber" : 1,
    "Items" : {
      "Backup" : {
        "BackupMethod" : "Physical",
        "BackupInitiator" : "System",
        "StorageClass" : 0,
        "BackupIntranetDownloadURL" : "http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/xxxxx",
        "BackupSize" : 2167808,
        "BackupMode" : "Automated",
        "BackupId" : 321020562,
        "IsAvail" : 1,
        "Encryption" : "{}",
        "HostInstanceID" : 5882781,
        "StoreStatus" : "Disabled",
        "BackupDownloadURL" : "http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/xxxxx",
        "DBInstanceId" : "rm-uf6wjk5xxxxxxx",
        "CopyOnlyBackup" : 0,
        "BackupEndTime" : "2019-02-13T12:20:00Z",
        "ConsistentTime" : 1576506856,
        "BackupStartTime" : "2019-02-03T12:20:00Z",
        "MetaStatus" : "OK",
        "BackupType" : "FullBackup",
        "BackupStatus" : "Success",
        "BackupDownloadLinkByDB" : {
          "BackupDownloadLinkByDB" : {
            "DownloadLink" : "https://cn-hangzhou.bak.rds.aliyuncs.com/custins53664665/hins18676859_2021072909473127987849.zip?Expires=*****&amp;dbList=tb1",
            "IntranetDownloadLink" : "https://cn-hangzhou-internal.bak.rds.aliyuncs.com/custins53664665/hins18676859_2021072909473127987849.zip?Expires=*****&amp;dbList=tb1",
            "DataBase" : "dbs"
          }
        }
      }
    }
  }
}

错误码

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