文档

CheckCreateDdrDBInstance - 预检查实例是否可以进行跨地域恢复

更新时间:

该接口用于预检查某RDS实例是否可以用跨地域备份集进行跨地域恢复。

接口说明

适用引擎

  • RDS MySQL
  • RDS PostgreSQL
  • RDS SQL Server

相关功能文档

注意 使用该接口前,请仔细阅读功能文档,确保完全了解使用接口的前提条件及使用后造成的影响后,再进行操作。

调试

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

授权信息

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

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

请求参数

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

目的实例地域 ID,可以通过接口 DescribeRegions 查看地域 ID。

cn-hangzhou
Enginestring

目标数据库类型,取值:

  • MySQL
  • SQLServer
  • PostgreSQL
MySQL
EngineVersionstring

目标数据库版本。根据 Engine 参数取值的不同,本参数取值如下:

  • MySQL:5.5/5.6/5.7/8.0
  • SQL Server:2008r2/08r2_ent_ha/2012/2012_ent_ha/2012_std_ha/2012_web/2014_std_ha/2016_ent_ha/2016_std_ha/2016_web/2017_std_ha/2017_ent/2019_std_ha/2019_ent
  • PostgreSQL:10.0/11.0/12.0/13.0/14.0/15.0
5.6
DBInstanceClassstring

目的实例规格,详见实例规格表

rds.mysql.s1.small
DBInstanceStorageinteger

目的实例存储空间,取值: 5~2000。 每 5G 进行递增,单位:GB。详见实例规格表

20
RestoreTypestring

恢复方式,取值:

  • 0:基于备份集恢复,您还需要传入参数 BackupSetId
  • 1:基于时间点恢复,您还需要传入参数 RestoreTimeSourceRegionSourceDBInstanceName

默认值:0

0
BackupSetIdstring

基于备份集恢复时,使用的备份集的 ID。可以通过接口 DescribeCrossRegionBackups 查看备份集 ID。

说明 RestoreType=0 时必传。
14358
RestoreTimestring

基于时间点恢复时,要恢复的时间节点,需要早于当前时间。格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

说明 RestoreType=1 时必传 。
2019-05-30T03:29:10Z
SourceRegionstring

基于时间点恢复时,源地域的 ID。

说明 RestoreType=1 时必传。
cn-hangzhou
SourceDBInstanceNamestring

基于时间点恢复时,源实例的 ID。

说明 RestoreType=1 时必传。
rm-uf6wjk5****
ResourceGroupIdstring

资源组 ID。可调用 DescribeDBInstanceAttribute 获取。

rg-acfmy****

返回参数

名称类型描述示例值
object

返回参数详情。

IsValidstring

是否能创建容灾恢复实例。取值:

  • true
  • false
true
RequestIdstring

请求 ID。

1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC

示例

正常返回示例

JSON格式

{
  "IsValid": "true",
  "RequestId": "1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC"
}

错误码

HTTP status code错误码错误信息描述
400IncorrectDBInstanceTypeCurrent DB instance engine and type does not support operations.操作失败,当前数据库实例引擎和类型不支持。
400InvalidRestoreType.FormatSpecified restore type is not valid.指定的恢复类型无效。请设置合理的恢复类型。
400NoBackupSetRegionBackupSetRegion is absence.操作失败,备份区域不存在。
400IncorrectBackupSetTypeBackup set type should be ddr.操作失败,备份集类型需为ddr类型。
400NoSourceInstanceNameNo SourceDBInstanceName.操作失败,没有源实例名称。
400NoAvailableDisasterRestoreBaksetNo available disaster restore bakset.操作失败,当前没有可用的恢复集。
400IncorrectBackupSetMethodCurrent backup set method does not support operations.操作失败,指定的备份集不支持库表恢复。
400InvalidBackupType.FormatSpecified backup type is not valid.操作失败,指定的备份类型无效。
400IncorrectEngineVersionCurrent engine version does not support operations.操作失败,当前数据库版本不支持此操作。
400IncorrectBaksetVersionCurrent bakset version does not support operations.操作失败,当前备份集(bakset)版本不支持。
400CrossRegionUnsupportTDECross-region disaster restore not support TDE bakset.跨区域灾难恢复不支持TDE备份集。
400DisasterRestoreRegionNotMatchedDisaster restore should be operated in the ddr region or source region.灾难恢复应在ddr区域或源区域中进行。
400InvalidMinorVersion.NotFoundSpecified minor version does not exists.操作失败,指定的RDS内核版本不存在。
400InvalidDBInstanceId.MalFormedThe specified parameter DBInstanceId is not valid.实例ID无效,请检查实例ID是否存在。
400InvalidEngine.MalformedSpecified engine is not valid.当前数据库引擎无效,请选择正确的数据库引擎。
400InvalidEngineVersion.MalformedSpecified engine version is not valid.数据库引擎版本无效,请确认后重试。
400MissingUserIDThe request is missing a user_id parameter.用户ID不存在。
400MissingUIDThe request is missing a uid parameter.操作失败,当前请求缺失UID。
400UserPermissionFailureThe request processing has failed due to user permission.用户权限不足。
400InvalidServiceType.FormatSpecified service type is not valid.无效的服务类型。请重新设置,0为aliyun服务,1为jst服务。
400InvalidStorage.FormatSpecified Storage is not valid.Storage参数值无效。请设置合理的参数取值。
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.调用商品服务返回失败。
403IncorrectDBTypeThe current DB type does not support this operation.操作失败,当前数据库类型不支持此操作,请使用其他类型的数据库进行操作。
403IncorrectDBInstanceThe current DB instance does not support this operation.操作失败,当前实例不支持此操作。
403ResourceConfigErrorThe request processing has failed due to resource config error.由于资源配置错误,请求处理失败。
404RestoreType.NotFoundRestoreType is not found.恢复方式(RestoreType)未找到。
404InvalidBackupSetID.NotFoundSpecified backup set ID does not exist.备份集不存在。请查看已存在的备份集。
404InvalidDBInstance.NotFoundThe specified instance does not exist or is not supported.没有找到指定的实例,请检查实例的正确性。
404InvalidDBInstanceClass.NotFoundSpecified DB instance class is not found.当前选择的配置或规格不存在或已停售,请重新选择。

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

变更历史

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