调用DescribeCrossRegionBackups接口查询某RDS实例跨地域数据备份文件列表。

查询跨地域日志备份文件请参见DescribeCrossRegionLogBackupFiles

仅适用于如下实例类型:

调试

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

请求参数

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

系统规定参数。取值:DescribeCrossRegionBackups

DBInstanceId String rm-uf6wjk5xxxxxxxxxx

实例ID。

RegionId String cn-hangzhou

实例所在地域ID。

CrossBackupRegion String cn-shanghai

跨地域备份目的地域ID。

CrossBackupId Integer 14562

跨地域备份文件ID。

说明 CrossBackupId和起止时间参数(StartTimeEndTime)必须传入其中一组。
StartTime String 2019-05-30T12:10:00Z

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

EndTime String 2019-06-15T12:10:00Z

查询结束时间。格式:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

PageSize Integer 30

每页记录数,取值:

  • 30
  • 50
  • 100

默认值:30。

PageNumber Integer 1

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

默认值:1

BackupId Integer 603524***

用户备份ID。

返回数据

名称 类型 示例值 描述
EndTime String 2019-06-15T12:10:00Z

查询结束时间。

StartTime String 2019-05-30T12:10:00Z

查询开始时间。

RequestId String 60912B41-7579-4B5D-B289-8856030F0A6A

请求ID。

PageRecordCount Integer 30

本页备份文件个数。

TotalRecordCount Integer 100

总记录数。

PageNumber Integer 1

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

默认值:1

RegionId String cn-hangzhou

实例所在地域ID。

Items Array of Item

跨地域备份列表。

Item
ConsistentTime String 2019-06-12T05:44:46Z

备份文件里数据的时间点。

DBInstanceStorageType String ssd

存储类型。取值:

  • local_ssd:本地SSD盘(推荐)
  • cloud_ssd:SSD云盘
  • cloud_essd:ESSD云盘
CrossBackupId Integer 14377

跨地域备份文件ID。

BackupType String F

跨地域备份类型,取值:

  • F:全量;
  • I:增量。
BackupStartTime String 2019-05-30T12:10:00Z

跨地域备份开始时间。

CrossBackupSetLocation String oss

备份文件存储位置。

InstanceId Integer 8161055

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

CrossBackupDownloadLink String http://rdsddrbak-shanghai.oss-cn-shanghai.aliyuncs.com/xxxxx

跨地域备份文件外网下载链接。

BackupEndTime String 2019-06-15T12:10:00Z

RDS侧的备份生成时间。

EngineVersion String 5.6

数据库版本。

BackupSetStatus Integer 0

转储完成的备份文件状态,取值:

  • 0:完成备份
  • 1:备份失败
CrossBackupSetFile String cn-hangzhou_rm-xxxxx_hins81xxx_data_20190612134426_qp.xb

跨地域备份文件压缩包名称。

BackupSetScale Integer 0

备份文件的备份策略,取值:

  • 0:实例备份
  • 1:单库备份
CrossBackupSetSize Long 5312836

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

CrossBackupRegion String cn-shanghai

跨地域备份的目的地域ID。

Category String HighAvailability

实例系列,取值:

  • Basic:基础版
  • HighAvailability:高可用版
  • Finance:三节点企业版(仅中国站支持)
Engine String mysql

数据库类型。

BackupMethod String P

跨地域备份方式,取值:

  • L:逻辑备份
  • P:物理备份
RestoreRegions Array of String "cn-hangzhou", "cn-shanghai"

备份文件可以进行恢复的地域列表,即备份文件可以恢复到哪些地域。

示例

请求示例

http(s)://rds.aliyuncs.com/?Action=DescribeCrossRegionBackups
&DBInstanceId=rm-uf6wjk5xxxxxxxxxx
&RegionId=cn-hangzhou
&CrossBackupId=14562
&<公共请求参数>

正常返回示例

XML格式

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

<DescribeCrossRegionBackupsResponse>
<Items>
		<Item>
			<CrossBackupSetFile>cn-hangzhou_rm-bpxxxxx_hins798xxxx_data_20190611125201.tar.gz</CrossBackupSetFile>
			<BackupSetScale>0</BackupSetScale>
			<BackupType>F</BackupType>
			<InstanceId>7980000</InstanceId>
			<CrossBackupId>14358</CrossBackupId>
			<BackupEndTime>2019-06-11T04:55:02Z</BackupEndTime>
			<BackupMethod>P</BackupMethod>
			<CrossBackupSetLocation>oss</CrossBackupSetLocation>
			<CrossBackupSetSize>2179643</CrossBackupSetSize>
			<Engine>mysql</Engine>
			<BackupStartTime>2019-06-11T04:52:46Z</BackupStartTime>
			<CrossBackupDownloadLink>http://rdsddrbak-zb.oss-cn-zhangjiakou.aliyuncs.com/cn-hangzhou_rm-bpxxxxx_hins7986073_data_20190611125201.tar.gz?OSSAccessKeyId=LTAxxxxx&amp;Expires=1560501641&amp;Signature=laK0kxxxxx%3D</CrossBackupDownloadLink>
			<Category>HighAvailability</Category>
			<CrossBackupRegion>cn-zhangjiakou</CrossBackupRegion>
			<RestoreRegions>
				<RestoreRegion>cn-hangzhou</RestoreRegion>
				<RestoreRegion>cn-zhangjiakou</RestoreRegion>
			</RestoreRegions>
			<EngineVersion>5.7</EngineVersion>
			<DBInstanceStorageType>ssd</DBInstanceStorageType>
		</Item>
	</Items>
	<TotalRecordCount>1</TotalRecordCount>
	<PageNumber>1</PageNumber>
	<RequestId>60912B41-7579-4B5D-B289-8856030F0A6A</RequestId>
	<RegionId>cn-hangzhou</RegionId>
	<EndTime>2019-06-11T08:00:00Z</EndTime>
	<StartTime>2019-06-10T00:00:00Z</StartTime>
	<PageRecordCount>30</PageRecordCount>
    </DescribeCrossRegionBackupsResponse>

JSON格式

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

{
  "Items" : {
    "Item" : [ {
      "CrossBackupSetFile" : "cn-hangzhou_rm-bpxxxxx_hins798xxxx_data_20190611125201.tar.gz",
      "BackupSetScale" : 0,
      "BackupType" : "F",
      "InstanceId" : 7980000,
      "CrossBackupId" : 14358,
      "BackupEndTime" : "2019-06-11T04:55:02Z",
      "BackupMethod" : "P",
      "CrossBackupSetLocation" : "oss",
      "CrossBackupSetSize" : 2179643,
      "Engine" : "mysql",
      "BackupStartTime" : "2019-06-11T04:52:46Z",
      "CrossBackupDownloadLink" : "http://rdsddrbak-zb.oss-cn-zhangjiakou.aliyuncs.com/cn-hangzhou_rm-bpxxxxx_hins7986073_data_20190611125201.tar.gz?OSSAccessKeyId=LTAxxxxx&Expires=1560501641&Signature=laK0kxxxxx%3D",
      "Category" : "HighAvailability",
      "CrossBackupRegion" : "cn-zhangjiakou",
      "RestoreRegions" : {
        "RestoreRegion" : [ "cn-hangzhou", "cn-zhangjiakou" ]
      },
      "EngineVersion" : "5.7",
      "DBInstanceStorageType" : "ssd"
    } ]
  },
  "TotalRecordCount" : 1,
  "PageNumber" : 1,
  "RequestId" : "60912B41-7579-4B5D-B289-8856030F0A6A",
  "RegionId" : "cn-hangzhou",
  "EndTime" : "2019-06-11T08:00:00Z",
  "StartTime" : "2019-06-10T00:00:00Z",
  "PageRecordCount" : 30
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidRegion.Format Specified Region is not valid. 指定的地域不合法,请检查该参数的正确性。
400 InvalidStartTime.Format Specified start time is not valid. 指定的起始时间无效。
400 InvalidEndTime.Format Specified end time is not valid. 您提交的结束时间无效,请重新提交正确信息
400 InvalidTime.Format Specified time is not valid. 操作失败,时间格式有误。
404 InvalidDBInstance.NotFound Specified instance does not exist or not support. 指定的实例不存在指定的实例被删除或者实例不支持当前操作。

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