调用DescribeMetaList查询目标备份集中可恢复的库表信息。

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

说明 实例为MySQL 8.0、5.7、5.6高可用版(本地SSD盘)。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeMetaList

系统规定参数。取值:DescribeMetaList

DBInstanceId String rm-uf6wjk5xxxxxxx

实例ID。可调用DescribeDBInstances获取。

ClientToken String ETnLKlblzczshOTUbOCzxxxxxxxxxx

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

RestoreType String BackupSetID

恢复方式,取值:

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

默认值:BackupSetID

BackupSetID Integer 14358

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

说明 RestoreTypeBackupSetID时必传。
RestoreTime String 2019-05-30T03:29:10Z

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

说明 RestoreTypeRestoreTime时必传 。
GetDbName String testdb1

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

说明 为空则返回包含所有数据库的列表。
Pattern String test

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

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

每页记录数。默认值:1

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

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

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

返回数据

名称 类型 示例值 描述
DBInstanceName String rm-uf6wjk5xxxxxxx

实例名称。

Items Array of Meta

备份中的库表信息列表。

Meta
Database String testdb1

数据库名称。

Size String 64

表的大小,单位:KB。

Tables String test1

表名称。

PageNumber Integer 1

页码。

PageRecordCount Integer 1

本页记录数。

RequestId String 60F9A12A-16B8-4728-B099-4CA38D32C31C

请求ID。

TotalPageCount Integer 1

总页数。

TotalRecordCount Integer 1

总记录数。

示例

请求示例

http(s)://rds.aliyuncs.com/?Action=DescribeMetaList
&DBInstanceId=rm-uf6wjk5xxxxxxx
&<公共请求参数>

正常返回示例

XML格式

<DescribeMetaList>
      <TotalPageCount>1</TotalPageCount>
      <TotalRecordCount>1</TotalRecordCount>
      <PageRecordCount>1</PageRecordCount>
      <RequestId>60F9A12A-16B8-4728-B099-4CA38D32C31C</RequestId>
      <PageNumber>1</PageNumber>
      <Items>
            <Meta>
                  <Size>64</Size>
                  <Database>testdb1</Database>
                  <Tables>test1</Tables>
            </Meta>
      </Items>
      <DBInstanceName>rm-uf6wjk5xxxxxxx</DBInstanceName>
</DescribeMetaList>

JSON格式

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

错误码

HttpCode 错误码 错误信息 描述
404 InvalidBackupSetID.NotFound Specified backup set ID does not exist. 指定的备份集 ID 不存在。
403 InvalidBackupLogStatus Current backup log enable status does not support this operation. 日志备份未开启,无法按时间点恢复
400 InvalidRestoreTime.Format Specified restore time is not valid. 指定的恢复时间无效。

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