预检查某RDS实例是否可以用跨地域备份集进行跨地域恢复。
接口说明
仅适用于如下实例类型:
- RDS MySQL:支持的实例版本请参见MySQL跨地域备份。
- RDS SQL Server:支持的实例版本请参见SQL Server跨地域备份。
- RDS PostgreSQL :支持的实例版本请参见PostgreSQL跨地域备份。
说明由于RDS PostgreSQL新旧架构切换,自2022年10月10日后新购的新架构实例暂不支持此功能。更多信息,请参见【通知】2022年10月10日起创建RDS PostgreSQL实例需SLR授权。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
rds:CheckCreateDdrDBInstance | READ |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 目的实例地域ID,可以通过接口DescribeRegions查看地域ID。 | cn-hangzhou |
Engine | string | 是 | 目标数据库类型,取值:
| MySQL |
EngineVersion | string | 是 | 目标数据库版本。根据Engine参数取值的不同,本参数取值如下:
| 5.6 |
DBInstanceClass | string | 是 | 目的实例规格,详见实例规格表。 | rds.mysql.s1.small |
DBInstanceStorage | integer | 是 | 目的实例存储空间,取值: 5~2000。 每5G进行递增,单位:GB。详见实例规格表。 | 20 |
RestoreType | string | 是 | 恢复方式,取值:
默认值:0。 | 0 |
BackupSetId | string | 否 | 基于备份集恢复时,使用的备份集的ID。可以通过接口DescribeCrossRegionBackups查看备份集ID。 说明RestoreType=0时必传。 | 14358 |
RestoreTime | string | 否 | 基于时间点恢复时,要恢复的时间节点,需要早于当前时间。格式:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。 说明RestoreType=1时必传 。 | 2019-05-30T03:29:10Z |
SourceRegion | string | 否 | 基于时间点恢复时,源地域的ID。 说明RestoreType=1时必传。 | cn-hangzhou |
SourceDBInstanceName | string | 否 | 基于时间点恢复时,源实例的ID。 说明RestoreType=1时必传。 | rm-uf6wjk5xxxxxxx |
返回参数
示例
正常返回示例
JSON
格式
{
"IsValid": "true",
"RequestId": "1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | IncorrectDBInstanceType | Current DB instance engine and type does not support operations. | 操作失败,当前数据库实例引擎和类型不支持。 |
400 | InvalidRestoreType.Format | Specified restore type is not valid. | 指定的恢复类型无效。请设置合理的恢复类型。 |
400 | NoBackupSetRegion | BackupSetRegion is absence. | 操作失败,备份区域不存在。 |
400 | IncorrectBackupSetType | Backup set type should be ddr. | 操作失败,备份集类型需为ddr类型。 |
400 | NoSourceInstanceName | No SourceDBInstanceName. | 操作失败,没有源实例名称。 |
400 | NoAvailableDisasterRestoreBakset | No available disaster restore bakset. | 操作失败,当前没有可用的恢复集。 |
400 | IncorrectBackupSetMethod | Current backup set method does not support operations. | 操作失败,指定的备份集不支持库表恢复。 |
400 | InvalidBackupType.Format | Specified backup type is not valid. | 操作失败,指定的备份类型无效。 |
400 | IncorrectEngineVersion | Current engine version does not support operations. | 操作失败,当前数据库版本不支持此操作。 |
400 | IncorrectBaksetVersion | Current bakset version does not support operations. | 操作失败,当前备份集(bakset)版本不支持。 |
400 | CrossRegionUnsupportTDE | Cross-region disaster restore not support TDE bakset. | 跨区域灾难恢复不支持TDE备份集。 |
400 | DisasterRestoreRegionNotMatched | Disaster restore should be operated in the ddr region or source region. | 灾难恢复应在ddr区域或源区域中进行。 |
400 | InvalidMinorVersion.NotFound | Specified minor version does not exists. | 操作失败,指定的RDS内核版本不存在。 |
400 | InvalidDBInstanceId.MalFormed | The specified parameter DBInstanceId is not valid. | 实例ID无效,请检查实例ID是否存在。 |
400 | InvalidEngine.Malformed | Specified engine is not valid. | 当前数据库引擎无效,请选择正确的数据库引擎。 |
400 | InvalidEngineVersion.Malformed | Specified engine version is not valid. | 数据库引擎版本无效,请确认后重试。 |
400 | MissingUserID | The request is missing a user_id parameter. | 用户ID不存在。 |
400 | MissingUID | The request is missing a uid parameter. | 操作失败,当前请求缺失UID。 |
400 | UserPermissionFailure | The request processing has failed due to user permission. | 用户权限不足。 |
400 | InvalidServiceType.Format | Specified service type is not valid. | 无效的服务类型。请重新设置,0为aliyun服务,1为jst服务。 |
400 | InvalidStorage.Format | Specified Storage is not valid. | Storage参数值无效。请设置合理的参数取值。 |
403 | IncorrectDBType | The current DB type does not support this operation. | 操作失败,当前数据库类型不支持此操作,请使用其他类型的数据库进行操作。 |
403 | IncorrectDBInstance | The current DB instance does not support this operation. | 操作失败,当前实例不支持此操作。 |
403 | ResourceConfigError | The request processing has failed due to resource config error. | 由于资源配置错误,请求处理失败。 |
404 | RestoreType.NotFound | RestoreType is not found. | 恢复方式(RestoreType)未找到。 |
404 | InvalidBackupSetID.NotFound | Specified backup set ID does not exist. | 备份集不存在。请查看已存在的备份集。 |
404 | InvalidDBInstance.NotFound | The specified instance does not exist or is not supported. | 没有找到指定的实例,请检查实例的正确性。 |
404 | InvalidDBInstanceClass.NotFound | Specified DB instance class is not found. | 当前选择的配置或规格不存在或已停售,请重新选择。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||
---|---|---|---|---|---|---|---|---|
2022-09-01 | OpenAPI 错误码发生变更 | |||||||
|