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

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

接口说明

适用引擎

RDS MySQL（本地盘）
RDS PostgreSQL
RDS SQL Server

调试

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

调试

授权信息

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

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

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

请求参数

名称	类型	必填	描述	示例值
DBInstanceId	string	是	实例 ID。	rm-uf6wjk5****
RegionId	string	是	实例所在地域 ID。	cn-hangzhou
CrossBackupRegion	string	否	跨地域备份目的地域 ID。	cn-shanghai
CrossBackupId	integer	否	跨地域备份文件 ID。说明 CrossBackupId 和起止时间参数（StartTime、EndTime）必须传入其中一组。	14562
StartTime	string	否	查询开始时间，格式：yyyy-MM-ddTHH:mm:ssZ（GMT 时间）。说明非 0 时区需要在传入时在实际时间上减去 8 小时。	2024-03-05T02:21:00Z
EndTime	string	否	查询结束时间，格式：yyyy-MM-ddTHH:mm:ssZ（GMT 时间）。说明非 0 时区需要在传入时在实际时间上减去 8 小时。	2024-03-05T02:24:37Z
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	备份文件里数据的时间点。	2024-03-05T02:22:54Z
DBInstanceStorageType	string	存储类型。取值： local_ssd：本地 SSD 盘（推荐） cloud_ssd：SSD 云盘 cloud_essd：ESSD 云盘	ssd
CrossBackupId	integer	跨地域备份文件 ID。	1249****
BackupType	string	跨地域备份类型，取值： F：全量； I：增量。	F
BackupStartTime	string	跨地域备份开始时间。	2024-03-05T02:22:45Z
CrossBackupSetLocation	string	备份文件存储位置。	oss
InstanceId	integer	实例编号。用于区分该备份集产生于主实例或备实例。	8161***
CrossBackupDownloadLink	string	跨地域备份文件外网下载链接。	http://rdsddrbak-shanghai.oss-cn-shanghai.aliyuncs.com/****
BackupEndTime	string	RDS 侧的备份生成时间。	2024-03-05T02:23:37Z
EngineVersion	string	数据库版本。	5.6
BackupSetStatus	integer	转储完成的备份文件状态，取值： 0：完成备份 1：备份失败	0
CrossBackupSetFile	string	跨地域备份文件压缩包名称。	cn-hangzhou_rm-****_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": "2024-03-05T02:22:54Z",
        "DBInstanceStorageType": "ssd",
        "CrossBackupId": 0,
        "BackupType": "F",
        "BackupStartTime": "2024-03-05T02:22:45Z",
        "CrossBackupSetLocation": "oss",
        "InstanceId": 0,
        "CrossBackupDownloadLink": "http://rdsddrbak-shanghai.oss-cn-shanghai.aliyuncs.com/****",
        "BackupEndTime": "2024-03-05T02:23:37Z",
        "EngineVersion": "5.6",
        "BackupSetStatus": 0,
        "CrossBackupSetFile": "cn-hangzhou_rm-****_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.	操作失败，时间格式有误。
400	Order.ComboInstanceNotAllowOperate	A package instance is not allowed to operate independently.	套餐实例不允许单独操作。
400	Price.PricingPlanResultNotFound	Pricing plan price result not found.	定价计划价格结果没有找到。
400	Order.NoRealNameAuthentication	You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.	您还未通过实名认证，不符合购买条件，请登录用户中心进行实名认证。
400	InsufficientAvailableQuota	Your account quota limit is less than 0, please recharge before trying to purchase.	您的账户可用额度小于0，请先充值后再尝试购买。
400	CommodityServiceCalling.Exception	Failed to call commodity service.	调用商品服务返回失败。
400	RegionDissolvedEOM	Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.	客户您好，阿里云计划对当前地域进行优化调整，该区域云服务将停止运营，为确保您的业务连续性及数据迁移工作的平稳过渡，您目前无法操作新购类型的订单，感谢理解与支持。
400	Commodity.InvalidComponent	The module you purchased is not legal, please buy it again.	您购买的模块不合法，请重新购买。
400	RegionEndTimeDissolvedIndia	Cloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.	客户您好，印度地域裁撤，购买的服务效期不能超过2024.07.15。
400	RegionEndTimeDissolvedAustralia	Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.	客户您好，澳洲地域裁撤，购买的服务效期不能超过2024.09.30
400	Price.CommoditySys	Commodity system call exception.	商品系统调用异常。
400	Pay.InsufficientBalance	Insufficient available balance.	可用金不足。
400	Order.PeriodInvalid	There is a problem with the period you selected, please choose again.	您选购的周期有问题，请重新选购。
400	pay.noCreditCard	Account not bound to credit card.	账户未绑定信用卡。
400	Order.InstHasUnpaidOrder	There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.	您选购的服务存在未支付订单，请支付或作废后再下单。
400	noAvailablePaymentMethod	No payment method is specified for your account. We recommend that you add a payment method.	没有为您的帐户指定付款方式。我们建议您添加一种付款方式。
400	BasicInfoUncompleted	Your information is incomplete. Complete your information before the operation.	您的基本信息未完善，请在操作前先完善您的基本信息。
400	Risk.RiskControlRejection	Your account is abnormal, please contact customer service for details.	您的账户出现异常，详情请联系客服。
400	BasicInfoUncompleted	Your information is incomplete, Complete your information before the operation.	您的信息不完整，请在操作前填写您的信息。
400	System.SaleValidateFailed	Sales expression validation system error.	销售表达式校验系统错误。
403	CrossBackupNotSupport	Specified region not support cross region backup.	指定的区域不支持跨区域备份。
403	OrderStatus.UnPaid	The specified db instance has unpaid order.	实例当前存在未支付订单，请支付后重试。
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

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

接口说明

适用引擎

相关功能文档

调试

授权信息

请求参数

返回参数

示例

错误码

变更历史