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

调试

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

请求参数

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

系统规定参数,取值:DescribeBackups。

InstanceId String r-bp1xxxxxxxxxxxxx

实例ID。

StartTime String 2019-03-11T10:00Z

查询开始时间,例如:2018-12-21T18:10Z

EndTime String 2019-03-14T18:00Z

查询结束时间,例如:2018-12-28T18:10Z

BackupId Integer 111111111

备份文件的ID。

PageNumber Integer 1

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

PageSize Integer 30

每页最大记录数。

NeedAof String 1

是否开启AoF落盘,可选值:

  • 0,表示关闭。
  • 1,表示开启。
说明 默认值:0
RegionId String cn-hangzhou

地域ID。

返回数据

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

请求ID。

PageNumber Integer 1

页码。

PageSize Integer 30

每页最大记录数。

TotalCount Integer 5

备份总个数。

Backups Array

由Backup组成的集合,显示备份文件的详细信息。

BackupId Integer 111111111

备份文件ID。

BackupDBNames String all

备份的DB。

BackupStatus String Success

备份状态:

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

备份开始时间。

BackupEndTime String 2019-03-14T05:31:13Z

备份结束时间。

BackupType String FullBackup

备份类型:

  • FullBackup(全量备份)
  • IncrementalBackup(增量备份)
BackupMode String Automated

备份模式:

  • Automated(自动备份)
  • Manual(手动触发备份)
BackupMethod String Physical

备份方法:

  • Logical(逻辑备份)
  • Physical(物理备份)
BackupDownloadURL String https://rdsbak-hk45-v2.oss-cn-hongkong.aliyuncs.com/xxxxxxxxxxx

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

BackupSize Long 1024

备份文件大小。

EngineVersion String 4.0

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

NodeInstanceId String r-bp1xxxxxxxxxxxxx

节点ID。

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

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

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

示例

请求示例

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

正常返回示例

XML 格式

<DescribeBackupsResponse>
	  <PageNumber>1</PageNumber>
	  <TotalCount>3</TotalCount>
	  <PageSize>30</PageSize>
	  <RequestId>6D7D871F-8A6B-40C2-85C7-3632D139EAFD</RequestId>
	  <Backups>
		    <Backup>
			      <BackupIntranetDownloadURL>http://rdsbak-hk45-v2.oss-cn-hongkong-internal.aliyuncs.com/xxxxxxxxxxx</BackupIntranetDownloadURL>
			      <BackupType>FullBackup</BackupType>
			      <BackupEndTime>2019-03-14T05:31:13Z</BackupEndTime>
			      <BackupMethod>Physical</BackupMethod>
			      <BackupId>336077354</BackupId>
			      <BackupStartTime>2019-03-14T05:28:50Z</BackupStartTime>
			      <BackupDownloadURL>https://rdsbak-hk45-v2.oss-cn-hongkong.aliyuncs.com/xxxxxxxxxxx</BackupDownloadURL>
			      <BackupDBNames>all</BackupDBNames>
			      <NodeInstanceId>r-bp1xxxxxxxxxxxxx</NodeInstanceId>
			      <BackupMode>Automated</BackupMode>
			      <BackupStatus>Success</BackupStatus>
			      <BackupSize>1024</BackupSize>
			      <EngineVersion>4.0</EngineVersion>
		    </Backup>
		    <Backup>
			      <BackupIntranetDownloadURL>http://rdsbak-hk45-v2.oss-cn-hongkong-internal.aliyuncs.com/xxxxxxxxxxx</BackupIntranetDownloadURL>
			      <BackupType>FullBackup</BackupType>
			      <BackupEndTime>2019-03-13T05:31:09Z</BackupEndTime>
			      <BackupMethod>Physical</BackupMethod>
			      <BackupId>335538809</BackupId>
			      <BackupStartTime>2019-03-13T05:28:46Z</BackupStartTime>
			      <BackupDownloadURL>http://rdsbak-hk45-v2.oss-cn-hongkong-internal.aliyuncs.com/xxxxxxxxxxx</BackupDownloadURL>
			      <BackupDBNames>all</BackupDBNames>
			      <NodeInstanceId>r-bp1xxxxxxxxxxxxx</NodeInstanceId>
			      <BackupMode>Automated</BackupMode>
			      <BackupStatus>Success</BackupStatus>
			      <BackupSize>1024</BackupSize>
			      <EngineVersion>4.0</EngineVersion>
		    </Backup>
		    <Backup>
			      <BackupIntranetDownloadURL>http://rdsbak-hk45-v2.oss-cn-hongkong-internal.aliyuncs.com/xxxxxxxxxxx</BackupIntranetDownloadURL>
			      <BackupType>FullBackup</BackupType>
			      <BackupEndTime>2019-03-12T05:31:14Z</BackupEndTime>
			      <BackupMethod>Physical</BackupMethod>
			      <BackupId>335001607</BackupId>
			      <BackupStartTime>2019-03-12T05:28:52Z</BackupStartTime>
			      <BackupDownloadURL>https://rdsbak-hk45-v2.oss-cn-hongkong.aliyuncs.com/http://rdsbak-hk45-v2.oss-cn-hongkong-internal.aliyuncs.com/xxxxxxxxxxx</BackupDownloadURL>
			      <BackupDBNames>all</BackupDBNames>
			      <NodeInstanceId>r-bp1xxxxxxxxxxxxx</NodeInstanceId>
			      <BackupMode>Automated</BackupMode>
			      <BackupStatus>Success</BackupStatus>
			      <BackupSize>1024</BackupSize>
			      <EngineVersion>4.0</EngineVersion>
		    </Backup>
	  </Backups>
</DescribeBackupsResponse>

JSON 格式

{
    "DescribeBackupsResponse": {
        "PageNumber": "1",
        "TotalCount": "3",
        "PageSize": "30",
        "RequestId": "6D7D871F-8A6B-40C2-85C7-3632D139EAFD",
        "Backups": {
            "Backup": [
                {
                    "BackupIntranetDownloadURL": "http://rdsbak-hk45-v2.oss-cn-hongkong-internal.aliyuncs.com/xxxxxxxxxxx",
                    "BackupType": "FullBackup",
                    "BackupEndTime": "2019-03-14T05:31:13Z",
                    "BackupMethod": "Physical",
                    "BackupId": "336077354",
                    "BackupStartTime": "2019-03-14T05:28:50Z",
                    "BackupDownloadURL": "https://rdsbak-hk45-v2.oss-cn-hongkong.aliyuncs.com/xxxxxxxxxxx",
                    "BackupDBNames": "all",
                    "NodeInstanceId": "r-bp1xxxxxxxxxxxxx",
                    "BackupMode": "Automated",
                    "BackupStatus": "Success",
                    "BackupSize": "1024",
                    "EngineVersion": "4.0"
                },
                {
                    "BackupIntranetDownloadURL": "http://rdsbak-hk45-v2.oss-cn-hongkong-internal.aliyuncs.com/xxxxxxxxxxx",
                    "BackupType": "FullBackup",
                    "BackupEndTime": "2019-03-13T05:31:09Z",
                    "BackupMethod": "Physical",
                    "BackupId": "335538809",
                    "BackupStartTime": "2019-03-13T05:28:46Z",
                    "BackupDownloadURL": "http://rdsbak-hk45-v2.oss-cn-hongkong-internal.aliyuncs.com/xxxxxxxxxxx",
                    "BackupDBNames": "all",
                    "NodeInstanceId": "r-bp1xxxxxxxxxxxxx",
                    "BackupMode": "Automated",
                    "BackupStatus": "Success",
                    "BackupSize": "1024",
                    "EngineVersion": "4.0"
                },
                {
                    "BackupIntranetDownloadURL": "http://rdsbak-hk45-v2.oss-cn-hongkong-internal.aliyuncs.com/xxxxxxxxxxx",
                    "BackupType": "FullBackup",
                    "BackupEndTime": "2019-03-12T05:31:14Z",
                    "BackupMethod": "Physical",
                    "BackupId": "335001607",
                    "BackupStartTime": "2019-03-12T05:28:52Z",
                    "BackupDownloadURL": "https://rdsbak-hk45-v2.oss-cn-hongkong.aliyuncs.com/http://rdsbak-hk45-v2.oss-cn-hongkong-internal.aliyuncs.com/xxxxxxxxxxx",
                    "BackupDBNames": "all",
                    "NodeInstanceId": "r-bp1xxxxxxxxxxxxx",
                    "BackupMode": "Automated",
                    "BackupStatus": "Success",
                    "BackupSize": "1024",
                    "EngineVersion": "4.0"
                }
            ]
        }
    }
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidStartTime.Malformed The Specified parameter StartTime is not valid. 开始时间验证失败,时间格式应该为gmt时间例如2011-06-11T16:00Z
400 InvalidEndTime.Malformed The Specified parameter EndTime is not valid. 结束时间验证失败,时间格式应该为gmt时间例如2011-06-11T16:00Z

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