接口说明
说明
恢复前可以调用CheckCreateDdrDBInstance接口预检查某RDS实例是否可以用跨地域备份集进行跨地域恢复。
适用引擎
RDS MySQL
相关功能文档
注意 使用该接口前，请仔细阅读功能文档，确保完全了解使用接口的前提条件及使用后造成的影响后，再进行操作。
- RDS MySQL跨地域备份
- RDS MySQL跨地域恢复
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI
Explorer可以自动生成SDK代码示例。
调试
调试
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| rds:RestoreDdrTable | WRITE |
|
|
无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DBInstanceId | string | 是 |
要恢复的已有实例ID。 |
rm-bp**** |
| RegionId | string | 否 |
目标地域ID，可以通过接口DescribeRegions查看地域ID。 |
cn-hangzhou |
| ClientToken | string | 否 |
用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过64个ASCII字符，且该参数值中不能包含非ASCII字符。 |
ETnLKlblzczshOTUbOCz**** |
| RestoreType | string | 是 |
恢复方式，取值：
默认值：0。 |
0 |
| BackupId | string | 否 |
跨地域备份集ID。可以通过接口DescribeCrossRegionBackups查询。 说明 | 279563 |
| RestoreTime | string | 否 | 恢复时间点恢复的时间，需要早于当前时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。 说明 | 2020-04-25T16:00:00Z |
| SourceRegion | string | 否 | 基于时间点恢复的来源地域。 说明 | cn-beijing |
| SourceDBInstanceName | string | 否 | 基于时间点恢复的来源实例ID。 说明 | rm-bp**** |
| TableMeta | string | 是 | 指定恢复的库表。格式： |
[{“type”:”db”,”name”:”testdb1″,”newname”:”testdb1″,”tables”:[{“type”:”table”,”name”:”test1″,”newname”:”test1_backup”},{“type”:”table”,”name”:”test2″,”newname”:”test2_backup”}]}] |
| ResourceGroupId | string | 否 |
资源组ID。 |
rg-acfmy**** |
返回参数
| 名称 | 类型 | 描述 | 示例值 |
|---|---|---|---|
| object |
返回参数详情。 |
||
| RequestId | string |
请求ID。 |
75BBF1EF-1E90-4950-BFFB-252D26E8259B |
| DBInstanceId | string |
实例ID。 |
rm-uf6wjk5**** |
示例
正常返回示例
JSON格式
{
"RequestId": "75BBF1EF-1E90-4950-BFFB-252D26E8259B",
"DBInstanceId": "rm-uf6wjk5****"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | InvalidRestoreType.Format | Specified restore type is not valid. | 指定的恢复类型无效。请设置合理的恢复类型。 |
| 400 | InvalidRestoreTime.Format | Specified restore time is not valid. | 操作失败，当前指定的恢复时间无效，请重新设置恢复时间。 |
| 400 | InvalidBakset.Invalid | Specified bakset is not valid. | – |
| 400 | InvalidParamTableMetaForRestore.Content | new dbname or table in TableMeta cannot be same with old when restore to source instance | – |
| 400 | InvalidParamTableMeta | Invalid parameter TableMeta is null or not json format | 参数TableMeta不合法，请检查该参数的正确性。 |
| 400 | InvalidBakHistoryDO | BakHistory is inbalid when check restore TableMeta | – |
| 400 | InvalidParamTableMeta.Content | TableMeta missing old dbname or new dbname, please check | 指定的table_meta参数缺少指定恢复的旧表和新表。 |
| 400 | InvalidParamTableMeta.Duplicate | TableMeta has duplicate db or table with other newname, commons or system | 操作失败，数据库中已存在指定恢复的库表。 |
| 400 | InvalidSourceRestoreDBName.NotFound | specific source restore dbname is not found in db list | 操作失败，备份集中不存在指定恢复的数据库。 |
| 400 | InvalidDBName.Duplicate | Specified DB name already exists in the This instance. | 当前实例中已存在相同的数据库名称。请更换名称。 |
| 400 | InvalidParameters.Format | Specified parameters is not valid. | 无效的参数。 |
| 400 | InvalidAvZone.Format | Specified AvZone is not valid. | 指定的AvZone不合法，请检查该参数的正确性。 |
| 400 | InvalidRegion.Format | Specified Region is not valid. | 指定的地域不合法，请检查该参数的正确性。 |
| 400 | InvalidVpcParameter | Specified VPCId VSwitchId or IPAddress or TunnelId is not valid. | VPCId VSwitchId不合法，请检查VPCId VSwitchId的正确性。 |
| 400 | MissingUserID | The request is missing a user_id parameter. | 用户ID不存在。 |
| 400 | MissingUID | The request is missing a uid parameter. | 操作失败，当前请求缺失UID。 |
| 403 | IncorrectDBInstanceType | Current DB instance type does not support this operation. | 操作失败，该实例状态下不支持此操作。 |
| 403 | IncorrectDBInstanceState | Current DB instance state does not support this operation. | 当前实例状态不支持此操作。 |
| 403 | ChildDBInstanceExists | Current DB instance had child instance. | 操作失败，只读实例已存在。 |
| 403 | InvalidBackupLogStatus | Current backup log enable status does not support this operation. | 操作失败，日志备份未开启，无法按时间点恢复。 |
| 403 | IncorrectBackupSetMethod | Current backup set method does not support operations. | 操作失败，指定的备份集不支持库表恢复。 |
| 403 | IncorrectBackupSetState | Current backup set state does not support operations. | 操作失败，当前备份集状态不支持此操作。 |
| 404 | RestoreType.NotFound | RestoreType is not found. | 恢复方式（RestoreType）未找到。 |
| 404 | InvalidBackupSetID.NotFound | Specified backup set ID does not exist. | 备份集不存在。请查看已存在的备份集。 |
| 404 | InsufficientResourceCapacity | There is insufficient capacity available for the requested instance. | – |
| 404 | InvalidBackup.NotFound | The available backup does not exist in recovery time. | 没有可用的备份集用于恢复数据。 |
| 404 | InvalidBinlog.NotFound | The available binlog does not exist in recovery time. | 指定恢复时间点的binlog无效。 |
| 404 | InvalidDB.NotFound | Specified db does not exist or DB status does not support. | 指定的数据库不存在或数据库状态不支持。 |
| 404 | InvalidDBInstance.NotFound | Specified instance does not exist or not support. | 指定的实例不存在指定的实例被删除或者实例不支持当前操作。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 2022-08-11 | OpenAPI 描述信息更新，OpenAPI 错误码发生变更 | 看变更集 | ||||||||||
|
内容没看懂？ 不太想学习？想快速解决？ 有偿解决： 联系专家
阿里云企业补贴进行中： 马上申请
腾讯云限时活动1折起，即将结束： 马上收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折，更有现金返利:同意关联，立享优惠
转转请注明出处：https://www.yunxiaoer.com/154182.html