该接口用于查询目标备份集中可恢复的库表信息。
接口说明
适用引擎
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:DescribeMetaList | Read |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ClientToken | string | 否 | 用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过 64 个 ASCII 字符,且该参数值中不能包含非 ASCII 字符。 | ETnLKlblzczshOTUbOCz**** |
DBInstanceId | string | 是 | 实例 ID。可调用 DescribeDBInstances 获取。 | rm-uf6wjk5**** |
RestoreType | string | 否 | 恢复方式,取值:
默认值:BackupSetID | BackupSetID |
BackupSetID | integer | 否 | 基于备份集查询时,使用的备份集的 ID。可调用 DescribeBackups 获取。 说明
RestoreType 为 BackupSetID 时必传。
| 14*** |
RestoreTime | string | 否 | 基于时间点查询时,使用的时间节点,需要早于当前时间。格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。可调用 DescribeBackups 获取。 说明
RestoreType 为 RestoreTime 时必传 。
| 2019-05-30T03:29:10Z |
GetDbName | string | 否 | 要查询的数据库名。精确匹配,会返回具体的数据库名以及库内所有的表。 说明
为空则返回包含所有数据库的列表。
| testdb1 |
Pattern | string | 否 | 要查询的数据库名。模糊匹配,只返回匹配的数据库名,不返回表名。 说明
例如传入 test 匹配testdb1 和testdb2 ,确定目标数据库名称后再通过 GetDbName 参数传入精确的数据库名称查看目标库下所有表的信息。
| test |
PageSize | integer | 否 | 每页记录数。默认值:1。 说明
需要和 PageIndex 一起传入才生效。
| 1 |
PageIndex | integer | 否 | 页码,取值:大于 0 且不超过 Integer 的最大值。默认值:1。 说明
需要和 PageSize 一起传入才生效。
| 1 |
ResourceGroupId | string | 否 | 资源组 ID。 | rg-acfmy**** |
返回参数
示例
正常返回示例
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 | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | NoAvailableDisasterRestoreBakset | No available disaster restore bakset | - |
400 | InvalidPageSize | The page size is invalid | pageSize值不合法,请输入数字。 |
400 | InvalidPageIndex | The page index is invalid | - |
400 | InvalidRestoreTime.Format | Specified restore time is not valid. | 操作失败,当前指定的恢复时间无效,请重新设置恢复时间。 |
400 | Order.ComboInstanceNotAllowOperate | A package instance is not allowed to operate independently. | 套餐实例不允许单独操作。 |
400 | Price.PricingPlanResultNotFound | Pricing plan price result not found. | 定价计划价格结果没有找到。 |
400 | Order.NoRealNameAuthentication | You 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. | 您还未通过实名认证,不符合购买条件,请登录用户中心进行实名认证。 |
400 | InsufficientAvailableQuota | Your account quota limit is less than 0, please recharge before trying to purchase. | 您的账户可用额度小于0,请先充值后再尝试购买。 |
400 | CommodityServiceCalling.Exception | Failed to call commodity service. | 调用商品服务返回失败。 |
403 | InvalidMeta.Empty | Meta information is empty. | 元信息是空的 |
403 | InvalidMeta.TooLarge | Meta information is too large. | - |
403 | IncorrectDBInstanceType | Current DB instance type does not support this operation. | 操作失败,该实例状态下不支持此操作。 |
403 | IncorrectEngineVersion | Current engine version does not support operations. | 操作失败,当前数据库版本不支持此操作。 |
403 | InvalidBackupLogStatus | Current backup log enable status does not support this operation. | 操作失败,日志备份未开启,无法按时间点恢复。 |
404 | InvalidBackupSetID.NotFound | Specified backup set ID does not exist. | 备份集不存在。请查看已存在的备份集。 |
404 | InvalidParameters.Format | Specified parameter({}) is not valid. | - |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
2022-08-04 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 看变更集 | ||||||||||||
|