文档

CreateDdrInstance - 跨地域恢复数据到新实例

更新时间:

该接口用于跨地域恢复数据到新实例。

接口说明

说明 恢复前可以调用 CheckCreateDdrDBInstance 接口预检查某 RDS 实例是否可以用跨地域备份集进行跨地域恢复。

适用引擎

  • RDS MySQL
  • RDS PostgreSQL
  • RDS SQL Server

相关功能文档

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

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
rds:CreateDdrInstanceWrite
  • 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:9.4/10.0/11.0/12.0/13.0
5.6
DBInstanceClassstring

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

rds.mysql.s1.small
DBInstanceStorageinteger

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

20
SystemDBCharsetstring

目标实例的字符集,取值:

  • utf8
  • gbk
  • latin1
  • utf8mb4
uft8
DBInstanceNetTypestring

目标实例的网络连接类型,取值:

  • Internet:公网连接
  • Intranet:内网连接
Intranet
DBInstanceDescriptionstring

目标实例名称,长度为 2~256 个字符。以中文、英文字母开头,可以包含数字、中文、英文、下划线(_)、短横线(-)。

说明 不能以 http:// 和 https:// 开头。
testdb
SecurityIPListstring

目标实例的 IP 白名单,多个 IP 地址请以半角逗号(,)隔开,不可重复,最多 1000 个。支持如下两种格式:

  • IP 地址形式,例如:10.23.12.24。
  • CIDR 形式,例如:10.23.12.24/24(无类域间路由,24 表示了地址中前缀的长度,范围为 1~32)。
127.0.0.1
ClientTokenstring

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

ETnLKlblzczshOTUbOCz****
PayTypestring

目标实例的付费类型,取值:

  • Postpaid:后付费(按量付费)
  • Prepaid:预付费(包年包月)
Prepaid
ZoneIdstring

目标实例的可用区 ID。多可用区用英文冒号(:)分隔。

说明 指定了 VPC 和交换机时,为匹配交换机对应的可用区,该参数必填。
cn-hangzhou-b
InstanceNetworkTypestring

目标实例的网络类型,取值:

  • VPC:VPC 网络
  • Classic:经典网络

默认创建经典网络类型的实例。

说明 当本参数值为 VPC 时,还需要传入参数 VpcIdVSwitchId
Classic
ConnectionModestring

目标实例的访问模式,取值:

  • Standard:标准访问模式
  • Safe:数据库代理模式

默认值:Standard

Standard
VPCIdstring

目标实例的 VPC ID。当 InstanceNetworkType=VPC 时,本参数可用。

说明 如果传入此参数,您还需要传入参数 ZoneId
vpc-****
VSwitchIdstring

目标实例的虚拟交换机 ID,多个值用半角逗号(,)隔开。当 InstanceNetworkType=VPC 时,本参数可用。

说明 如果传入此参数,您还需要传入参数 ZoneId
vsw-****
PrivateIpAddressstring

设置目标实例的内网 IP,需要在指定交换机的 IP 地址范围内。系统默认通过 VPCIdVSwitchId 自动分配。

172.XX.XX.69
UsedTimestring

指定购买时长,取值:

  • 当参数 PeriodYear 时,UsedTime 取值为1~3
  • 当参数 PeriodMonth 时,UsedTime 取值为1~9
说明 若付费类型为 Prepaid 则该参数必须传入。
2
Periodstring

指定预付费目标实例为包年或者包月类型,取值:

  • Year:包年
  • Month:包月
说明 若付费类型为 Prepaid 则该参数必须传入。
Year
ResourceGroupIdstring

资源组 ID。

rg-acfmy****
RestoreTypestring

恢复方式,取值:

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

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

说明 RestoreType=BackupSet 时必传。
14****
RestoreTimestring

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

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

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

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

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

说明 RestoreType=BackupTime 时必传。
rm-uf6wjk5****
DBInstanceStorageTypestring

目标实例存储类型,当前仅支持 SSD 本地盘,默认值:local_ssd

local_ssd

返回参数

名称类型描述示例值
object

返回参数详情。

DBInstanceIdstring

新实例 ID。

rm-****
RequestIdstring

请求 ID。

E52666CC-330E-418A-8E5B-A19E3FB42D13
Portstring

新实例连接端口。

说明 参数 DBInstanceNetType 决定该端口为内网端口或外网端口。
3306
ConnectionStringstring

新实例连接地址。

说明 参数 DBInstanceNetType 决定该地址为内网或外网。
rm-****.mysql.rds.aliyuncs.com
OrderIdstring

订单 ID。

2038691****

示例

正常返回示例

JSON格式

{
  "DBInstanceId": "rm-****",
  "RequestId": "E52666CC-330E-418A-8E5B-A19E3FB42D13",
  "Port": "3306",
  "ConnectionString": "rm-****.mysql.rds.aliyuncs.com",
  "OrderId": "2038691****"
}

错误码

HTTP status code错误码错误信息描述
400InvalidZoneId.NotSupportedThe Specified vpc Zone not supported.当前可用区不支持创建VPC网络类型实例,请更换可用区。
400InvalidDBInstanceName.FormatSpecified DB instance name is not valid.当前实例不存在,请检查该实例是否存在。
400InvalidDBInstanceName.DuplicateSpecified DB instance name already exists in the Aliyun RDS.操作失败,实例名称已存在,请修改实例名称后重试。
400InvalidRegion.FormatSpecified Region is not valid.指定的地域不合法,请检查该参数的正确性。
400InvalidServiceType.FormatSpecified service type is not valid.无效的服务类型。请重新设置,0为aliyun服务,1为jst服务。
400InvalidEngine.MalformedSpecified engine is not valid.当前数据库引擎无效,请选择正确的数据库引擎。
400InvalidEngineVersion.MalformedSpecified engine version is not valid.数据库引擎版本无效,请确认后重试。
400InvalidConnectionString.FormatSpecified connection string is not valid.实例连接地址的字符串格式不正确。字符串前缀长度为5~40。
400InvalidConnectionString.DuplicateSpecified connection string already exists in the Aliyun RDS.链接地址名重复,请重新设置连接字符串。
400InvalidCharacterSetName.FormatSpecified character set name is not valid.字符集格式不正确。RDS支持如下格式的字符集:gbk,utf8,euckr,ascii。
400InvalidDBInstanceType.FormatSpecified instance type is not valid.操作失败,指定实例类型无效。请选择正确的实例类型。
400InvalidPort.MalformedSpecified port is not valid.指定的端口无效。
400InvalidBackupRetentionPeriod.MalformedSpecified backup retention period is not valid.备份周期无效。备份周期需大于1天或小于等于30天。
400InvalidPreferredBackupTime.FormatSpecified preferred backup time is not valid.期望备份日期的格式不正确。格式要求为标准GMT格式,即YYYY-MM-DDThh:mmZ。例如:2012-06-11T15:00Z
400InvalidPreferredBackupPeriod.MalformedSpecified backup period is not valid.备份时间无效。
400InvalidOptmizationServiceSpecified optmization service is not valid.-
400InvalidExpiredTime.FormatSpecified expired time is not valid.失效时间格式(ExpiredTime)不正确,格式要求如下:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。
400InvalidSecurityIPList.FormatSpecified security IP list format is not valid.指定的IP List格式不符合要求,请检查格式规范
400InvalidSecurityIPList.DuplicateSpecified security IP list is not valid: Duplicate IP address in the list指定的安全IP列表无效。其中包含重复值。
400InvalidSecurityIPList.QuotaExceededSpecified security IP list is not valid: Exceeding the allowed amount of IP address in the list.指定的安全IP列表中包含的IP地址数超过允许上限。SecurityIPList支持最多1000个IP地址。
400InvalidDBInstanceDescription.FormatSpecified DB instance description is not valid.参数DBInstanceDescription无效,请检查参数正确性。参数需符合以下规则:长度为2~256个字符。以中文、英文字母开头,可以包含数字、中文、英文、下划线(_)、短横线(-)。
400InvalidStorage.FormatSpecified Storage is not valid.Storage参数值无效。请设置合理的参数取值。
400InvalidDBInstanceConnType.FormatSpecified DB instance conn type is not valid.操作失败,当前数据库实例的连接类型不支持此操作。
400PreCheckInvalidCreateDdrInstance PreCheck Is Invalid 跨地域恢复数据到新实例(CreateDdrInstance)预检查无效。
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 value ddr.-
400NoBaksetNameBaksetName is absence.操作失败,备份集名称不存在。
400NoSourceInstanceNameNo SourceDBInstanceName.操作失败,没有源实例名称。
400NoAvailableDisasterRestoreBaksetNo available disaster restore bakset.操作失败,当前没有可用的恢复集。
400InvalidBackupType.FormatSpecified backup type is not valid.操作失败,指定的备份类型无效。
400IncorrectEngineVersionCurrent engine version does not support operations.操作失败,当前数据库版本不支持此操作。
400DisasterRestoreRegionNotMatchedDisaster restore should be operated in the ddr region or source region.灾难恢复应在ddr区域或源区域中进行。
400InvalidVpcIdRegion.NotSupportedThe Specified vSwitchId zone not supported.-
400VswitchIpExhaustedNo available ip in the specified vswitch.指定的vswitch中没有可用的IP。
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.调用商品服务返回失败。
400RegionDissolvedEOMDear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.客户您好,阿里云计划对当前地域进行优化调整,该区域云服务将停止运营,为确保您的业务连续性及数据迁移工作的平稳过渡,您目前无法操作新购类型的订单,感谢理解与支持。
400Commodity.InvalidComponentThe module you purchased is not legal, please buy it again.您购买的模块不合法,请重新购买。
400RegionEndTimeDissolvedIndiaCloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.客户您好,印度地域裁撤,购买的服务效期不能超过2024.07.15。
400RegionEndTimeDissolvedAustraliaCloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.客户您好,澳洲地域裁撤,购买的服务效期不能超过2024.09.30
400Price.CommoditySysCommodity system call exception.商品系统调用异常。
400Pay.InsufficientBalanceInsufficient available balance.可用金不足。
400Order.PeriodInvalidThere is a problem with the period you selected, please choose again.您选购的周期有问题,请重新选购。
400pay.noCreditCardAccount not bound to credit card.账户未绑定信用卡。
400Order.InstHasUnpaidOrderThere is an unpaid order for the service you have purchased. Please pay or void it before placing the order.您选购的服务存在未支付订单,请支付或作废后再下单。
400noAvailablePaymentMethodNo payment method is specified for your account. We recommend that you add a payment method.没有为您的帐户指定付款方式。我们建议您添加一种付款方式。
400BasicInfoUncompletedYour information is incomplete. Complete your information before the operation.您的基本信息未完善,请在操作前先完善您的基本信息。
400Risk.RiskControlRejectionYour account is abnormal, please contact customer service for details.您的账户出现异常,详情请联系客服。
400BasicInfoUncompletedYour information is incomplete, Complete your information before the operation.您的信息不完整,请在操作前填写您的信息。
400Api.NotSupportSpecified api is not supported.当前接口不支持。
400ContainForbiddenLabelErrorThere is a label that prohibits placing orders. Please contact your distributor for assistance.存在禁止下单的标签,请联系您的分销商处理
400InvalidDBInstanceId.NotFoundThe DBInstanceId provided does not exist in records.提供的DBInstanceId不存在。
400InvalidInstanceLevel.DiskTypeSpecified instance level not support request disk type当前实例规格不支持该存储类型。
400InvalidParamSepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.指定的 wal_level 参数无效。实例中仍然存在复制槽,因此无法将其设置为replica。
400KmsApiErrorUser secret key invalid.用户密钥失效。
400System.SaleValidateFailedSales expression validation system error.销售表达式校验系统错误。
400Abs.InvalidAccount.NotFoundaccount is not found.账户不存在。
400SqlExecuteFailedOrTimeoutsql command execution failed or timed out:%s.sql命令执行失败或执行超时
400ColdData.EngineVersionNotSupportThe current instance engine version not support coldDataEnabled.当前实例引擎版本不支持归档冷数据。
400ColdData.MinorVersionNotSupportThe current instance minor version not support coldDataEnabled.当前内核版本不支持归档冷数据。
400IncorrectTargetClasscodeThe current instance type does not support this operation.当前规格不支持此操作。
400RequiredParam.NotFoundRequired input param is not found.没有传入必要的参数。
400Parameters.InvalidParameter error, please check the parameters.参数错误,请检查参数。
400BackupPolicyNotSupportCold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.数据归档不支持跨地域备份和秒级快照,请检查备份策略。
400InvalideStatus.FormatThe instance status does not support this operation.实例状态不支持此操作。
400InvalidReleasedKeepPolicy.FormatSpecified Released Keep Policy is not valid.实例释放后的归档备份保留策略无效。
400InvalidDBInstanceEngineType.Formatthe DB instance engine type does not support this operation.DB实例引擎类型不支持此操作。
400Pay.NoCreditCardNo credit cards.无信用卡。
400VpcNetworkTypeNotSupportThe vpc network type instance does not support this operation.vpc网络类型实例不支持此操作。
400MirrorInsExistsSpecified DB instance mirror ins already existed.当前数据库实例镜像已存在。
403IncorrectBackupSetMethodCurrent backup set method does not support operations.操作失败,指定的备份集不支持库表恢复。
403IncorrectBaksetVersionCurrent bakset version does not support operations.操作失败,当前备份集(bakset)版本不支持。
403CrossRegionUnsupportTDECross-region disaster restore not support TDE bakset.跨区域灾难恢复不支持TDE备份集。
403OperationDenied.ResourceSpecified DB instance class or storage is not available in all Availability Zones.资源不足,请变更实例规格或存储规格后再试。
403OperationDenied.ZoneResourceThere is no available zone for inventory.没有可用的库存区域。
403OrderStatus.UnPaidThe specified db instance has unpaid order.实例当前存在未支付订单,请支付后重试。
403InvalidReduceDiskSizeThe storage capacity after the scale-down must be larger than the used amount.缩容目标容量不能小于当前存储空间使用量
403CloudSSDNotSupportCloud ssd does not support this operation, please upgrade to essd.SSD盘不支持此操作,请升级至ESSD。
403InvalidUserOperatorPermissionThe user permission does not support this operation.用户权限不支持此操作。
403InvalidVswitchIdSpecified conn vswitch id is not valid.指定的VSwitchId格式不正确或为空
403IncorrectMinorVersionCurrent engine minor version does not support operations.当前引擎小版本不支持此操作。
403NotInFlowControllerSorry,no permission.非集团上云用户不可用,无权限。
403InvalidKmsKeyKms key is disabled.Kms key已禁用。
404InvalidRegion.NotFoundSpecified Region does not exist in the RDS地域无效。
404InvalidClusterName.NotFoundThe specified cluster name is not available.操作失败,集群名称不存在。请检查集群名称后重试。
404InvalidDBInstanceClass.NotFoundSpecified DB instance class is not found.当前选择的配置或规格不存在或已停售,请重新选择。
404InvalidDBInstanceNetType.NotFoundSpecified DB instance net type is not found.操作失败,实例网络类型不正确。请检查网络类型。
404RestoreType.NotFoundRestoreType is not found.恢复方式(RestoreType)未找到。
404InvalidBackupSetID.NotFoundSpecified backup set ID does not exist.备份集不存在。请查看已存在的备份集。
404InvalidClusterKmsThe current instance does not authorized to access the Key Management Service.当前实例未授权访问密钥管理服务。
404Request.NotFoundThe requested resource is not available.请求的资源不可用。
404HostInfo.NotFoundThe specified host info is not found.指定的主机信息不存在。
500ExternalFailureThe request processing has failed due to external service failure.请求服务失败,请稍后重试。
500RequestMetaDataFailedThe service request failed. Please try again later or contact service personnel.请求服务失败,请稍后再试或联系服务人员。

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

变更历史

变更时间变更内容概要操作
2024-05-29OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 403 变更
    删除错误码:400
    删除错误码:404
2024-05-27OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 403 变更
    删除错误码:400
    删除错误码:404
2023-07-14OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:403
    删除错误码:404
2023-01-11OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
2022-09-01OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:403
    删除错误码:404
  • 本页导读 (1)