调用该API可以查询备份文件的详细信息,包括备份开始时间、文件大小、备份方式及下载地址等详细信息。

请求参数

表 1. 请求参数
名称 类型 是否必须 描述
<公共请求参数> - 参见公共请求参数
Action String 系统规定参数,取值:DescribeBackups。
InstanceId String 实例 ID
BackupId String 备份集 ID
PagSize String 每页记录数,取值:30/50/100。
PageNumber String 页码,大于0,且不超过 Integer 的最大值。
StartTime String 查询开始时间,例如:2018-12-21T18:10Z。
EndTime String 查询结束时间,例如:2018-12-28T18:10Z。

返回参数

名称 类型 描述
<公共返回参数> - 参见公共返回参数
Backups List 由 Backup 组成的数组
PageNumber Integer 页码
TotalCount Integer 备份总个数
PageSize Integer 每页记录数
表 2. Backup参数说明
名称 类型 描述
BackupId String 备份集 ID
BackupDBNames String 备份的 DB 名称
BackupStatus String 备份集状态:
  • Success(成功)
  • Failed(失败)
BackupStartTime String 备份开始时间
BackupEndTime String 备份结束时间
BackupType String 备份类型:
  • FullBackup(全量备份)
  • IncrementalBackup(增量备份)
BackupMode String 备份模式:
  • Automated(自动备份)
  • Manual(手动触发备份)
BackupMethod String 备份方法:
  • Logical(逻辑备份)
  • Physical(物理备份)
BackupDownloadURL String 备份文件的 URL 下载地址
BackupSize String 备份集大小

请求示例

https://r-kvstore.aliyuncs.com/
?Action=DescribeBackups
&InstanceId=r-xxxxxxxxxxxxxxx
&PagSize=30
&PageNumber=1
&StartTime=018-10-20T20:36Z
&EndTime=2018-10-26T11:16Z
&<公共请求参数>

返回示例

XML格式
<DescribeBackupsResponse>
 <PageNumber>1</PageNumber>
 <TotalCount>5</TotalCount>
 <PageSize>30</PageSize>
 <RequestId>963C20F0-7CE1-4591-AAF3-6F3CD1CEB2F5</RequestId>
 <Backups>
   <Backup>
     <BackupIntranetDownloadURL>http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/xxxxxxxxxxx/xxxxxxxxxxxxxx.rdb?OSSAccessKeyId=LxxxxxxxxxxxxxxO&Expires=1540709757&Signature=bTXQpSkWf4nRfIMwqgKW42LU5Bc%3D</BackupIntranetDownloadURL>
     <BackupType>FullBackup</BackupType>
     <BackupEndTime>2018-10-25T19:08:33Z</BackupEndTime>
     <BackupMethod>Physical</BackupMethod>
     <BackupId>282273483</BackupId>
     <BackupStartTime>2018-10-25T19:06:12Z</BackupStartTime>
     <BackupDownloadURL>http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/xxxxxxxxxxx/xxxxxxxxxxxxxx.rdb?OSSAccessKeyId=LxxxxxxxxxxxxxxO&Expires=1540709757&Signature=bTXQpSkWf4nRfIMwqgKW42LU5Bc%3D</BackupDownloadURL>
     <BackupDBNames>all</BackupDBNames>
     <NodeInstanceId>r-xxxxxxxxxxxxxxx</NodeInstanceId>
     <BackupMode>Automated</BackupMode>
     <BackupStatus>Success</BackupStatus>
     <BackupSize>1024</BackupSize>
     <EngineVersion>4.0</EngineVersion>
   </Backup>
 </Backups>
</DescribeBackupsResponse>
JSON格式
{
   "PageNumber":1,
   "TotalCount":5,
   "PageSize":30,
   "RequestId":"963C20F0-7CE1-4591-AAF3-6F3CD1CEB2F5",
   "Backups":{
       "Backup":[
           {
               "BackupIntranetDownloadURL":"http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/xxxxxxxxxxx/xxxxxxxxxxxxxx.rdb?OSSAccessKeyId=LxxxxxxxxxxxxxxO&Expires=1540709757&Signature=bTXQpSkWf4nRfIMwqgKW42LU5Bc%3D",
               "BackupType":"FullBackup",
               "BackupEndTime":"2018-10-25T19:08:33Z",
               "BackupMethod":"Physical",
               "BackupId":282273483,
               "BackupStartTime":"2018-10-25T19:06:12Z",
               "BackupDownloadURL":"http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/xxxxxxxxxxx/xxxxxxxxxxxxxx.rdb?OSSAccessKeyId=LxxxxxxxxxxxxxxO&Expires=1540709757&Signature=bTXQpSkWf4nRfIMwqgKW42LU5Bc%3D",
               "BackupDBNames":"all",
               "NodeInstanceId":"r-xxxxxxxxxxxxxxx",
               "BackupMode":"Automated",
               "BackupStatus":"Success",
               "BackupSize":1024,
               "EngineVersion":"4.0"
           }
       ]
   }
}