文档

DescribeCrossRegionBackupDBInstance - 查询开启跨地域备份实例

更新时间:

该接口用于查询所选地域的哪些实例开启了跨地域备份,以及这些实例的跨地域备份设置。

接口说明

适用引擎

  • RDS MySQL
  • RDS PostgreSQL
  • RDS SQL Server

相关功能文档

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

调试

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

授权信息

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

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

请求参数

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

地域 ID。

cn-hangzhou
DBInstanceIdstring

实例 ID。一次最多传入 30 个实例 ID,以英文逗号(,)分隔。

rm-uf6wjk5****
PageSizeinteger

每页记录数。默认值:30。

30
PageNumberinteger

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

默认值:1

1

返回参数

名称类型描述示例值
object

返回参数详情。

RequestIdstring

请求 ID。

33517002-182D-40BE-93EC-610BD3381045
TotalRecordsinteger

总记录数。

100
ItemsNumbersinteger

跨地域备份设置列表内的 Item 数量。

1
PageSizeinteger

每页记录数。默认值:30。

30
PageNumberinteger

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

默认值:1

1
RegionIdstring

地域 ID。

cn-hangzhou
Itemsobject []

跨地域备份设置列表。

LogBackupEnabledTimestring

跨地域日志备份开启时间。格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2019-06-12T05:44:21Z
BackupEnabledstring

跨地域备份总开关,取值:

  • Disable:关闭
  • Enable:开启
Enable
DBInstanceStatusstring

实例状态,详情请参见实例状态表

Running
LockModestring

实例锁定状态,取值:

  • Unlock:正常
  • ManualLock:手动触发锁定
  • LockByExpiration:实例过期自动锁定
  • LockByRestoration:实例回滚前的自动锁定
  • LockByDiskQuota:实例空间满自动锁定(不可访问实例)
Unlock
EngineVersionstring

数据库版本。

5.6
LogBackupEnabledstring

跨地域日志备份开关,取值:

  • Disable:关闭
  • Enable:开启
Enable
RetentTypeinteger

跨地域备份保留方式。当前仅支持按配置时长保留,默认值:1

1
Retentioninteger

跨地域备份保留天数,取值:7~1825

15
CrossBackupTypestring

跨地域备份保存类型。默认值:1,表示每个备份都保存。

1
CrossBackupRegionstring

跨地域备份目的地域 ID。

cn-shanghai
DBInstanceIdstring

实例 ID。

rm-uf6wjk5****
Enginestring

数据库类型。

MySQL
BackupEnabledTimestring

跨地域数据备份开启时间。格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2019-06-12T05:44:21Z
DBInstanceDescriptionstring

实例名称,长度为 2~256 个字符。以中文、英文字母开头,可以包含数字、中文、英文、下划线(_)、短横线(-)。

说明 不能以 http:// 和 https:// 开头。
testdb

示例

正常返回示例

JSON格式

{
  "RequestId": "33517002-182D-40BE-93EC-610BD3381045",
  "TotalRecords": 100,
  "ItemsNumbers": 1,
  "PageSize": 30,
  "PageNumber": 1,
  "RegionId": "cn-hangzhou",
  "Items": {
    "Item": [
      {
        "LogBackupEnabledTime": "2019-06-12T05:44:21Z",
        "BackupEnabled": "Enable",
        "DBInstanceStatus": "Running",
        "LockMode": "Unlock",
        "EngineVersion": "5.6",
        "LogBackupEnabled": "Enable",
        "RetentType": 1,
        "Retention": 15,
        "CrossBackupType": "1",
        "CrossBackupRegion": "cn-shanghai",
        "DBInstanceId": "rm-uf6wjk5****",
        "Engine": "MySQL",
        "BackupEnabledTime": "2019-06-12T05:44:21Z",
        "DBInstanceDescription": "testdb"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400InvalidParameters.FormatSpecified parameter is not valid.-
400InvalidRegion.FormatSpecified Region 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.调用商品服务返回失败。
400RegionDissolvedEOMDear 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.客户您好,阿里云计划对当前地域进行优化调整,该区域云服务将停止运营,为确保您的业务连续性及数据迁移工作的平稳过渡,您目前无法操作新购类型的订单,感谢理解与支持。
400Commodity.InvalidComponentThe module you purchased is not legal, please buy it again.您购买的模块不合法,请重新购买。
400RegionEndTimeDissolvedIndiaCloud 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。
400RegionEndTimeDissolvedAustraliaCloud 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
400Price.CommoditySysCommodity system call exception.商品系统调用异常。
400Pay.InsufficientBalanceInsufficient available balance.可用金不足。
400Order.PeriodInvalidThere is a problem with the period you selected, please choose again.您选购的周期有问题,请重新选购。
400pay.noCreditCardAccount not bound to credit card.账户未绑定信用卡。
400Order.InstHasUnpaidOrderThere is an unpaid order for the service you have purchased. Please pay or void it before placing the order.您选购的服务存在未支付订单,请支付或作废后再下单。
400noAvailablePaymentMethodNo payment method is specified for your account. We recommend that you add a payment method.没有为您的帐户指定付款方式。我们建议您添加一种付款方式。
400BasicInfoUncompletedYour information is incomplete. Complete your information before the operation.您的基本信息未完善,请在操作前先完善您的基本信息。
400Risk.RiskControlRejectionYour account is abnormal, please contact customer service for details.您的账户出现异常,详情请联系客服。
400BasicInfoUncompletedYour information is incomplete, Complete your information before the operation.您的信息不完整,请在操作前填写您的信息。
400System.SaleValidateFailedSales expression validation system error.销售表达式校验系统错误。
403CrossBackupNotSupportSpecified region not support cross region backup.指定的区域不支持跨区域备份。
403IncorrectDBInstanceEngineCurrent DB Instance engine does not support this operation.操作失败,数据库引擎不支持。
403OrderStatus.UnPaidThe specified db instance has unpaid order.实例当前存在未支付订单,请支付后重试。
404InvalidPage.notFoundPage not found.指定参数未找到,请检查确认参数。
404InvalidUser.NotFoundSpecified user does not exist.指定用户不存在。请检查用户信息是否正确。

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

变更历史

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