DescribeCrossRegionBackups - 查询某RDS实例跨地域数据备份文件列表 - 云数据库 RDS

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

接口说明

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

仅适用于如下实例类型：

RDS MySQL：支持的实例版本请参见MySQL跨地域备份。
RDS SQL Server：支持的实例版本请参见SQL Server跨地域备份。
RDS PostgreSQL ：支持的实例版本请参见PostgreSQL跨地域备份。

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
rds:DescribeCrossRegionBackups	READ	RDS acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	rds:ResourceTag	无

请求参数

名称	类型	必填	描述	示例值
DBInstanceId	string	是	实例ID。	rm-uf6wjk5xxxxxxxxxx
RegionId	string	是	实例所在地域ID。	cn-hangzhou
CrossBackupRegion	string	否	跨地域备份目的地域ID。	cn-shanghai
CrossBackupId	integer	否	跨地域备份文件ID。说明CrossBackupId和起止时间参数（StartTime、EndTime）必须传入其中一组。	14562
StartTime	string	否	查询开始时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。	2019-05-30T12:10:00Z
EndTime	string	否	查询结束时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。	2019-06-15T12:10:00Z
PageSize	integer	否	每页记录数，取值： 30 50 100 默认值：30。	30
PageNumber	integer	否	页码，取值：大于0且不超过Integer的最大值。默认值：1。	1
BackupId	integer	否	用户备份ID。	603524***
ResourceGroupId	string	否	资源组ID。	rg-acfmy*****

返回参数

名称	类型	描述	示例值
	object
EndTime	string	查询结束时间。	2019-06-15T12:10:00Z
StartTime	string	查询开始时间。	2019-05-30T12:10:00Z
RequestId	string	请求ID。	60912B41-7579-4B5D-B289-8856030F0A6A
PageRecordCount	integer	本页备份文件个数。	30
TotalRecordCount	integer	总记录数。	100
PageNumber	integer	页码，取值：大于0且不超过Integer的最大值。默认值：1。	1
RegionId	string	实例所在地域ID。	cn-hangzhou
Items	object []	跨地域备份列表。
ConsistentTime	string	备份文件里数据的时间点。	2019-06-12T05:44:46Z
DBInstanceStorageType	string	存储类型。取值： local_ssd：本地SSD盘（推荐） cloud_ssd：SSD云盘 cloud_essd：ESSD云盘	ssd
CrossBackupId	integer	跨地域备份文件ID。	14377
BackupType	string	跨地域备份类型，取值： F：全量； I：增量。	F
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	RDS侧的备份生成时间。	2019-06-15T12:10:00Z
EngineVersion	string	数据库版本。	5.6
BackupSetStatus	integer	转储完成的备份文件状态，取值： 0：完成备份 1：备份失败	0
CrossBackupSetFile	string	跨地域备份文件压缩包名称。	cn-hangzhou_rm-xxxxx_hins81xxx_data_20190612134426_qp.xb
BackupSetScale	integer	备份文件的备份策略，取值： 0：实例备份 1：单库备份	0
CrossBackupSetSize	long	跨地域备份文件大小，单位：Byte。	5312836
CrossBackupRegion	string	跨地域备份的目的地域ID。	cn-shanghai
Category	string	实例系列，取值： Basic：基础版 HighAvailability：高可用版 Finance：三节点企业版（仅中国站支持）	HighAvailability
Engine	string	数据库类型。	mysql
BackupMethod	string	跨地域备份方式，取值： L：逻辑备份 P：物理备份	P
RestoreRegions	array	备份文件可以进行恢复的地域列表，即备份文件可以恢复到哪些地域。
	string	备份文件可以进行恢复的地域列表，即备份文件可以恢复到哪些地域。	"cn-hangzhou", "cn-shanghai"

示例

正常返回示例

JSON格式

{
  "EndTime": "2019-06-15T12:10:00Z",
  "StartTime": "2019-05-30T12:10:00Z",
  "RequestId": "60912B41-7579-4B5D-B289-8856030F0A6A",
  "PageRecordCount": 30,
  "TotalRecordCount": 100,
  "PageNumber": 1,
  "RegionId": "cn-hangzhou",
  "Items": {
    "Item": [
      {
        "ConsistentTime": "2019-06-12T05:44:46Z",
        "DBInstanceStorageType": "ssd",
        "CrossBackupId": 14377,
        "BackupType": "F",
        "BackupStartTime": "2019-05-30T12:10:00Z",
        "CrossBackupSetLocation": "oss",
        "InstanceId": 8161055,
        "CrossBackupDownloadLink": "http://rdsddrbak-shanghai.oss-cn-shanghai.aliyuncs.com/xxxxx",
        "BackupEndTime": "2019-06-15T12:10:00Z",
        "EngineVersion": "5.6",
        "BackupSetStatus": 0,
        "CrossBackupSetFile": "cn-hangzhou_rm-xxxxx_hins81xxx_data_20190612134426_qp.xb",
        "BackupSetScale": 0,
        "CrossBackupSetSize": 5312836,
        "CrossBackupRegion": "cn-shanghai",
        "Category": "HighAvailability",
        "Engine": "mysql",
        "BackupMethod": "P",
        "RestoreRegions": {
          "RestoreRegion": [
            "\"cn-hangzhou\", \"cn-shanghai\""
          ]
        }
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	ParameterAbsence	Necessary param is absence.	-
400	InvalidParameters.Format	Specified parameter is not valid.	-
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.	操作失败，时间格式有误。
403	CrossBackupNotSupport	Specified region not support cross region backup.	指定的区域不支持跨区域备份。
404	InvalidPage.notFound	Page not found.	指定参数未找到，请检查确认参数。
404	InvalidDBInstance.NotFound	Specified instance does not exist or not support.	指定的实例不存在指定的实例被删除或者实例不支持当前操作。

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

变更历史

变更时间

变更内容概要

操作

2022-09-01

OpenAPI 错误码发生变更

变更项	变更内容
错误码	OpenAPI 错误码发生变更
	错误码 404 变更
	删除错误码：400
	删除错误码：403