文档

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

更新时间:

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

接口说明

适用引擎

  • RDS MySQL(本地盘)
  • RDS PostgreSQL
  • RDS SQL Server

相关功能文档

注意 使用该接口前,请仔细阅读功能文档,确保完全了解使用接口的前提条件及使用后造成的影响后,再进行操作。

说明 如需查询跨地域日志备份文件,请参见 DescribeCrossRegionLogBackupFiles。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
rds:DescribeCrossRegionBackupsRead
  • DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
  • rds:ResourceTag

请求参数

名称类型必填描述示例值
DBInstanceIdstring

实例 ID。

rm-uf6wjk5****
RegionIdstring

实例所在地域 ID。

cn-hangzhou
CrossBackupRegionstring

跨地域备份目的地域 ID。

cn-shanghai
CrossBackupIdinteger

跨地域备份文件 ID。

说明 CrossBackupId 和起止时间参数(StartTimeEndTime)必须传入其中一组。
14562
StartTimestring

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

说明 非 0 时区需要在传入时在实际时间上减去 8 小时。
2024-03-05T02:21:00Z
EndTimestring

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

说明 非 0 时区需要在传入时在实际时间上减去 8 小时。
2024-03-05T02:24:37Z
PageSizeinteger

每页记录数,取值:

  • 30
  • 50
  • 100

默认值:30。

30
PageNumberinteger

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

默认值:1

1
BackupIdinteger

用户备份 ID。

603524****
ResourceGroupIdstring

资源组 ID。

rg-acfmy****

返回参数

名称类型描述示例值
object

返回参数详情。

EndTimestring

查询结束时间。

2019-06-15T12:10:00Z
StartTimestring

查询开始时间。

2019-05-30T12:10:00Z
RequestIdstring

请求 ID。

60912B41-7579-4B5D-B289-8856030F0A6A
PageRecordCountinteger

本页备份文件个数。

30
TotalRecordCountinteger

总记录数。

100
PageNumberinteger

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

默认值:1

1
RegionIdstring

实例所在地域 ID。

cn-hangzhou
Itemsobject []

跨地域备份列表。

ConsistentTimestring

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

2024-03-05T02:22:54Z
DBInstanceStorageTypestring

存储类型。取值:

  • local_ssd:本地 SSD 盘(推荐)
  • cloud_ssd:SSD 云盘
  • cloud_essd:ESSD 云盘
ssd
CrossBackupIdinteger

跨地域备份文件 ID。

1249****
BackupTypestring

跨地域备份类型,取值:

  • F:全量;
  • I:增量。
F
BackupStartTimestring

跨地域备份开始时间。

2024-03-05T02:22:45Z
CrossBackupSetLocationstring

备份文件存储位置。

oss
InstanceIdinteger

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

8161***
BackupEndTimestring

RDS 侧的备份生成时间。

2024-03-05T02:23:37Z
EngineVersionstring

数据库版本。

5.6
BackupSetStatusinteger

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

  • 0:完成备份
  • 1:备份失败
0
CrossBackupSetFilestring

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

cn-hangzhou_rm-****_hins81xxx_data_20190612134426_qp.xb
BackupSetScaleinteger

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

  • 0:实例备份
  • 1:单库备份
0
CrossBackupSetSizelong

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

5312836
CrossBackupRegionstring

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

cn-shanghai
Categorystring

实例系列,取值:

  • Basic:基础系列
  • HighAvailability:高可用系列
  • Finance:三节点企业系列(仅中国站支持)
HighAvailability
Enginestring

数据库类型。

mysql
BackupMethodstring

跨地域备份方式,取值:

  • L:逻辑备份
  • P:物理备份
P
RestoreRegionsarray

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

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错误码错误信息描述
400ParameterAbsenceNecessary param is absence.-
400InvalidParameters.FormatSpecified parameter is not valid.-
400InvalidRegion.FormatSpecified Region is not valid.指定的地域不合法,请检查该参数的正确性。
400InvalidStartTime.FormatSpecified start time is not valid.指定的起始时间无效。
400InvalidEndTime.FormatSpecified end time is not valid.您提交的结束时间无效,请重新提交正确信息
400InvalidTime.FormatSpecified time is not valid.操作失败,时间格式有误。
400Order.ComboInstanceNotAllowOperateA package instance is not allowed to operate independently.套餐实例不允许单独操作。
400Price.PricingPlanResultNotFoundPricing plan price result not found.定价计划价格结果没有找到。
400Order.NoRealNameAuthenticationYou 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.您还未通过实名认证,不符合购买条件,请登录用户中心进行实名认证。
400InsufficientAvailableQuotaYour account quota limit is less than 0, please recharge before trying to purchase.您的账户可用额度小于0,请先充值后再尝试购买。
400CommodityServiceCalling.ExceptionFailed to call commodity service.调用商品服务返回失败。
403CrossBackupNotSupportSpecified region not support cross region backup.指定的区域不支持跨区域备份。
404InvalidPage.notFoundPage not found.指定参数未找到,请检查确认参数。
404InvalidDBInstance.NotFoundSpecified instance does not exist or not support.指定的实例不存在指定的实例被删除或者实例不支持当前操作。

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

变更历史

变更时间变更内容概要操作
2022-09-01OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 404 变更
    删除错误码:400
    删除错误码:403
  • 本页导读 (1)
文档反馈