调用DescribeBackups查询Redis实例的备份文件信息。

调试

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

请求参数

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

系统规定参数。取值:DescribeBackups

RegionId String cn-hangzhou

实例所属的地域ID。

InstanceId String r-bp1zxszhcgatnx****

实例ID。

BackupId Integer 11611111

备份文件的ID。

PageSize Integer 30

每页最大记录数,取值:30、50、100、200或300。

PageNumber Integer 1

页码,取值大于0且不超过Integer数据类型的最大值,默认值为1

StartTime String 2019-03-11T10:00Z

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

EndTime String 2019-03-14T18:00Z

查询结束时间,必须晚于查询开始时间,格式为yyyy-MM-ddTHH:mmZ(UTC时间)。

NeedAof String 1

是否开启AoF落盘,取值:

  • 0:关闭。
  • 1:开启。
说明 默认值:0

返回数据

名称 类型 示例值 描述
RequestId String 963C20F0-7CE1-4591-AAF3-6F3CD1CE****

请求ID。

PageNumber Integer 1

页码。

PageSize Integer 30

每页最大记录数。

TotalCount Integer 5

备份总个数。

Backups Array of Backup

备份集详情。

Backup
BackupStatus String Success

备份状态,返回值:

  • Success:成功。
  • Failed:失败。
BackupStartTime String 2019-03-14T05:28:50Z

备份开始时间。

BackupType String FullBackup

备份类型,返回值:

  • FullBackup:全量备份。
  • IncrementalBackup:增量备份。
BackupDownloadURL String https://rdsbak-hk45-v2.oss-cn-hongkong.aliyuncs.com/********

备份文件的外网下载地址。

NodeInstanceId String r-bp10noxlhcoim2****-db-1

节点ID。

说明 当实例的架构为标准版时,本参数返回的是实例ID。
BackupEndTime String 2019-03-14T05:31:13Z

备份结束时间。

BackupId Integer 111111111

备份文件ID。

BackupDBNames String all

备份的数据库,默认为all,即备份所有数据库。

EngineVersion String 4.0

引擎版本,即Redis实例的大版本。

BackupIntranetDownloadURL String https://rdsbak-hk45-v2.oss-cn-hongkong.aliyuncs.com/********

备份文件的内网下载地址。

说明 您可以在与该Redis实例连通的ECS(二者需属于同地域的经典网络或者在同一VPC内)上使用该地址下载目标备份文件。
BackupSize Long 1024

备份文件大小。

BackupMode String Automated

备份模式,返回值:

  • Automated:自动备份。
  • Manual:手动备份。
BackupMethod String Physical

备份方法,返回值:

  • Logical:逻辑备份。
  • Physical:物理备份。

示例

请求示例

https://r-kvstore.aliyuncs.com/?Action=DescribeBackups
&InstanceId=r-bp1zxszhcgatnx****
&StartTime=2019-03-11T10:00Z
&EndTime=2019-03-14T18:00Z
&<公共请求参数>

正常返回示例

XML格式

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

<DescribeBackupsResponse>
    <TotalCount>1</TotalCount>
    <RequestId>721E2D39-351D-40E2-BF7C-B5075B0A****</RequestId>
    <PageSize>30</PageSize>
    <PageNumber>1</PageNumber>
    <Backups>
        <Backup>
            <BackupMethod>Physical</BackupMethod>
            <EngineVersion>4.0</EngineVersion>
            <BackupIntranetDownloadURL>http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/********</BackupIntranetDownloadURL>
            <BackupMode>Automated</BackupMode>
            <BackupSize>2263040</BackupSize>
            <BackupId>775661111</BackupId>
            <NodeInstanceId>r-bp12fdcf4dea****</NodeInstanceId>
            <BackupDBNames>all</BackupDBNames>
            <BackupDownloadURL>http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/********</BackupDownloadURL>
            <BackupEndTime>2020-10-30T17:31:26Z</BackupEndTime>
            <BackupStartTime>2020-10-30T17:28:28Z</BackupStartTime>
            <BackupType>FullBackup</BackupType>
            <BackupStatus>Success</BackupStatus>
        </Backup>
    </Backups>
</DescribeBackupsResponse>

JSON格式

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

{
  "TotalCount" : 1,
  "RequestId" : "721E2D39-351D-40E2-BF7C-B5075B0A****",
  "PageSize" : 30,
  "PageNumber" : 1,
  "Backups" : {
    "Backup" : [ {
      "BackupMethod" : "Physical",
      "EngineVersion" : "4.0",
      "BackupIntranetDownloadURL" : "http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/********",
      "BackupMode" : "Automated",
      "BackupSize" : 2263040,
      "BackupId" : 775661111,
      "NodeInstanceId" : "r-bp12fdcf4dea****",
      "BackupDBNames" : "all",
      "BackupDownloadURL" : "http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/********",
      "BackupEndTime" : "2020-10-30T17:31:26Z",
      "BackupStartTime" : "2020-10-30T17:28:28Z",
      "BackupType" : "FullBackup",
      "BackupStatus" : "Success"
    } ]
  }
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidEndTime.Malformed The Specified parameter EndTime is not valid. 结束时间验证失败,时间格式应该为gmt时间例如2011-06-11T16:00Z
400 InvalidStartTimeAndEndTime.Malformed The end time must be greater than the start time. 结束时间必须大于开始时间

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