文档

DescribeCrossBackupMetaList - 查询实例跨地域备份的库表信息

更新时间:

该接口用于查询RDS实例跨地域备份的库表信息。

接口说明

适用引擎

  • RDS MySQL
  • RDS PostgreSQL
  • RDS SQL Server

相关功能文档

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

调试

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

授权信息

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

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

请求参数

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

跨地域备份集 ID。可以通过接口 DescribeCrossRegionBackups 查询。

123456
GetDbNamestring

要查询的数据库名。精确匹配,会返回具体的数据库名以及库内的表名。

testdb1
Patternstring

要查询的数据库名。模糊匹配,只返回匹配的数据库名,不返回表名。

说明 您可以先模糊匹配,例如传入 test 匹配 testdb1 和 testdb2,确定目标数据库名称后再精确匹配,通过传入 GetDbName 查看具体的数据库名和表名。
test
PageSizestring

每页记录数。默认值:1

说明 需要和 PageIndex 一起传入才生效。
30
PageIndexstring

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

说明 需要和 PageSize 一起传入才生效。
1
Regionstring

实例所在地域。

cn-hangzhou
ResourceGroupIdstring

资源组 ID。

rg-acfmy****

返回参数

名称类型描述示例值
object

返回参数详情。

DBInstanceNamestring

跨地域备份集所属实例。

rm-uf6wjk5****
TotalPageCountinteger

总页数。

1
RequestIdstring

请求 ID。

60F9A12A-16B8-4728-B099-4CA38D32C31C
PageRecordCountinteger

本页记录数。

1
TotalRecordCountinteger

总记录数。

1
PageNumberinteger

页码。

1
Itemsobject []

备份集的库表信息列表。

Tablesstring

表名称,多个表用英文逗号(,)隔开。

test1,test2
Databasestring

数据库名称。

testdb1
Sizestring

表的大小,单位:KB。多个表用英文逗号(,)隔开。

1000

示例

正常返回示例

JSON格式

{
  "DBInstanceName": "rm-uf6wjk5****",
  "TotalPageCount": 1,
  "RequestId": "60F9A12A-16B8-4728-B099-4CA38D32C31C",
  "PageRecordCount": 1,
  "TotalRecordCount": 1,
  "PageNumber": 1,
  "Items": {
    "Meta": [
      {
        "Tables": "test1,test2",
        "Database": "testdb1",
        "Size": "1000"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400NoAvailableDisasterRestoreBaksetNo available disaster restore bakset-
400InvalidPageSizeThe page size is invalidpageSize值不合法,请输入数字。
400InvalidPageIndexThe page index is invalid-
400InvalidRestoreTime.FormatSpecified restore 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.调用商品服务返回失败。
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.销售表达式校验系统错误。
403InvalidMeta.EmptyMeta information is empty.元信息是空的
403InvalidMeta.TooLargeMeta information is too large.-
403IncorrectDBInstanceTypeCurrent DB instance type does not support this operation.操作失败,该实例状态下不支持此操作。
403IncorrectEngineVersionCurrent engine version does not support operations.操作失败,当前数据库版本不支持此操作。
403InvalidBackupLogStatusCurrent backup log enable status does not support this operation.操作失败,日志备份未开启,无法按时间点恢复。
403OrderStatus.UnPaidThe specified db instance has unpaid order.实例当前存在未支付订单,请支付后重试。
404InvalidBackupSetID.NotFoundSpecified backup set ID does not exist.备份集不存在。请查看已存在的备份集。
404InvalidParameters.FormatSpecified parameter({}) is not valid.-
404Request.NotFoundThe requested resource is not available.请求的资源不可用。

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

变更历史

变更时间变更内容概要操作
2022-08-04OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
入参OpenAPI 入参发生变更
    新增入参:ResourceGroupId
  • 本页导读 (1)
文档反馈