文档

DescribeMetaList - 查询备份集的库表信息

更新时间:

该接口用于查询目标备份集中可恢复的库表信息。

接口说明

适用引擎

RDS MySQL

说明 仅支持 MySQL 8.0、5.7、5.6 高可用版(本地 SSD 盘)。

功能说明

在使用 RestoreTable 接口进行 MySQL 单库单表恢复之前,您可以通过本接口查询可恢复的库表信息。

调试

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

授权信息

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

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

请求参数

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

用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过 64 个 ASCII 字符,且该参数值中不能包含非 ASCII 字符。

ETnLKlblzczshOTUbOCz****
DBInstanceIdstring

实例 ID。可调用 DescribeDBInstances 获取。

rm-uf6wjk5****
RestoreTypestring

恢复方式,取值:

  • BackupSetID:基于备份集恢复,您还需要传入参数 BackupSetID
  • RestoreTime:基于时间点恢复,您还需要传入参数 RestoreTime

默认值:BackupSetID

BackupSetID
BackupSetIDinteger

基于备份集查询时,使用的备份集的 ID。可调用 DescribeBackups 获取。

说明 RestoreTypeBackupSetID 时必传。
14***
RestoreTimestring

基于时间点查询时,使用的时间节点,需要早于当前时间。格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。可调用 DescribeBackups 获取。

说明 RestoreTypeRestoreTime 时必传 。
2019-05-30T03:29:10Z
GetDbNamestring

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

说明 为空则返回包含所有数据库的列表。
testdb1
Patternstring

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

说明 例如传入test匹配testdb1testdb2,确定目标数据库名称后再通过 GetDbName 参数传入精确的数据库名称查看目标库下所有表的信息。
test
PageSizeinteger

每页记录数。默认值:1

说明 需要和 PageIndex 一起传入才生效。
1
PageIndexinteger

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

说明 需要和 PageSize 一起传入才生效。
1
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
Databasestring

数据库名称。

testdb1
Sizestring

表的大小,单位:KB。

64

示例

正常返回示例

JSON格式

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

错误码

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.调用商品服务返回失败。
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.-

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

变更历史

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