全部产品
Search

搜索本产品

    云数据库 RDS：DescribeCrossBackupMetaList - 查询实例跨地域备份的库表信息

    文档中心

    云数据库 RDS：DescribeCrossBackupMetaList - 查询实例跨地域备份的库表信息

    更新时间：Mar 21, 2023

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

    接口说明

    RDS MySQL实例支持跨地域备份及恢复，详情请参见跨地域备份和跨地域恢复。

    仅适用于如下实例类型：

    调试

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

    调试

    授权信息

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

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

    请求参数

    名称类型必填描述示例值
    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-uf6wjk5xxxxxxx
    TotalPageCountinteger

    总页数。

    		1
    RequestIdstring

    请求ID。

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

    本页记录数。

    		1
    TotalRecordCountinteger

    总记录数。

    		1
    PageNumberinteger

    页码。

    		1
    Itemsarray

    备份集的库表信息列表。

    object
    Tablesstring

    表名称，多个表用英文逗号（,）隔开。

    		test1,test2
    Databasestring

    数据库名称。

    		testdb1
    Sizestring

    表的大小，单位：KB。多个表用英文逗号（,）隔开。

    		1000

    示例

    正常返回示例

    JSON格式

    {
  "DBInstanceName": "rm-uf6wjk5xxxxxxx",
  "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.操作失败，当前指定的恢复时间无效，请重新设置恢复时间。
    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.操作失败，日志备份未开启，无法按时间点恢复。
    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