调用CreateDdrInstance接口跨地域恢复数据到新实例。

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

仅适用于如下实例类型:

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String CreateDdrInstance

系统规定参数。取值:CreateDdrInstance

RegionId String cn-hangzhou

目标地域ID,可以通过接口DescribeRegions查看地域ID。

Engine String MySQL

目标数据库类型,取值:

  • MySQL
  • SQLServer
  • PostgreSQL
EngineVersion String 5.6

目标数据库版本。根据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
DBInstanceClass String rds.mysql.s1.small

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

DBInstanceStorage Integer 20

目标实例存储空间,取值: 5~2000

每5G进行递增,单位:GB。详见实例规格表

SystemDBCharset String uft8

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

  • utf8
  • gbk
  • latin1
  • utf8mb4
DBInstanceNetType String Intranet

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

  • Internet:公网连接
  • Intranet:内网连接
DBInstanceDescription String 测试数据库

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

说明 不能以 http:// 和 https:// 开头。
SecurityIPList String 127.0.0.1

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

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

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

PayType String Prepaid

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

  • Postpaid:后付费(按量付费)
  • Prepaid:预付费(包年包月)
ZoneId String cn-hangzhou-b

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

说明 指定了VPC和交换机时,为匹配交换机对应的可用区,该参数必填。
InstanceNetworkType String Classic

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

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

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

说明 当本参数值为VPC时,还需要传入参数VpcIdVSwitchId
ConnectionMode String Standard

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

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

默认值:Standard

VPCId String vpc-xxxxxxxxxxxx

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

说明 如果传入此参数,您还需要传入参数ZoneId
VSwitchId String vsw-xxxxxxxxxxx

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

说明 如果传入此参数,您还需要传入参数ZoneId
PrivateIpAddress String 172.16.201.69

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

UsedTime String 2

指定购买时长,取值:

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

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

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

资源组ID。

RestoreType String 0

恢复方式,取值:

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

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

说明 RestoreType=0时必传。
RestoreTime String 2019-05-30T03:29:10Z

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

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

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

说明 RestoreType=1时必传。
SourceDBInstanceName String rm-uf6wjk5xxxxxxx

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

说明 RestoreType=1时必传。
DBInstanceStorageType String local_ssd

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

BinlogName String

废弃参数。

BinlogPosition String

废弃参数。

BinlogRole String

废弃参数。

返回数据

名称 类型 示例值 描述
DBInstanceId String rm-xxxxx

新实例ID。

RequestId String E52666CC-330E-418A-8E5B-A19E3FB42D13

请求ID。

Port String 3306

新实例连接端口。

说明 参数DBInstanceNetType决定该端口为内网端口或外网端口。
ConnectionString String rm-xxxxx.mysql.rds.aliyuncs.com

新实例连接地址。

说明 参数DBInstanceNetType决定该地址为内网或外网。
OrderId String 2038691xxxxx

订单ID。

示例

请求示例

http(s)://rds.aliyuncs.com/?Action==CreateDdrInstance
&RegionId=cn-hangzhou
&Engine=MySQL
&EngineVersion=5.6
&DBInstanceClass=rds.mysql.s1.small
&DBInstanceStorage=20
&DBInstanceNetType=Intranet
&PayType=Prepaid
&RestoreType=0
&SecurityIPList=127.0.0.1
&BackupSetId=14358
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateDdrInstanceResponse>
    <RequestId>E52666CC-330E-418A-8E5B-A19E3FB42D13</RequestId>
    <DBInstanceId>rm-xxxxx</DBInstanceId>
    <Port>3306</Port>
    <ConnectionString>rm-xxxxx.mysql.rds.aliyuncs.com</ConnectionString>
    <OrderId>2038691xxxxx</OrderId>
</CreateDdrInstanceResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

HttpCode 错误码 错误信息 描述
400 InvalidZoneId.NotSupported The Specified vpc Zone not supported. 当前可用区不支持创建VPC网络类型实例,请更换可用区。
400 InvalidDBInstanceName.Format Specified DB instance name is not valid. 当前实例不存在,请检查该实例是否存在。
400 InvalidDBInstanceName.Duplicate Specified DB instance name already exists in the Aliyun RDS. 操作失败,实例名称已存在,请修改实例名称后重试。
400 InvalidRegion.Format Specified Region is not valid. 指定的地域不合法,请检查该参数的正确性。
400 InvalidServiceType.Format Specified service type is not valid. 无效的服务类型。请重新设置,0为aliyun服务,1为jst服务。
400 InvalidEngine.Malformed Specified engine is not valid. 当前数据库引擎无效,请选择正确的数据库引擎。
400 InvalidEngineVersion.Malformed Specified engine version is not valid. 数据库引擎版本无效,请确认后重试。
400 InvalidConnectionString.Format Specified connection string is not valid. 实例连接地址的字符串格式不正确。字符串前缀长度为5~40。
400 InvalidConnectionString.Duplicate Specified connection string already exists in the Aliyun RDS. 链接地址名重复,请重新设置连接字符串。
400 InvalidCharacterSetName.Format Specified character set name is not valid. 字符集格式不正确。RDS支持如下格式的字符集:gbk,utf8,euckr,ascii。
400 InvalidDBInstanceType.Format Specified instance type is not valid. 操作失败,指定实例类型无效。请选择正确的实例类型。
400 InvalidPort.Malformed Specified port is not valid. 指定的端口无效。
400 InvalidBackupRetentionPeriod.Malformed Specified backup retention period is not valid. 备份周期无效。备份周期需大于1天或小于等于30天。
400 InvalidPreferredBackupTime.Format Specified preferred backup time is not valid. 期望备份日期的格式不正确。格式要求为标准GMT格式,即YYYY-MM-DDThh:mmZ。例如:2012-06-11T15:00Z
400 InvalidPreferredBackupPeriod.Malformed Specified backup period is not valid. 备份时间无效。
400 InvalidOptmizationService Specified optmization service is not valid. 无效的参数优化服务。
400 InvalidExpiredTime.Format Specified expired time is not valid. 失效时间格式(ExpiredTime)不正确,格式要求如下:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。
400 InvalidSecurityIPList.Format Specified security IP list format is not valid. 指定的IP List格式不符合要求,请检查格式规范
400 InvalidSecurityIPList.Duplicate Specified security IP list is not valid: Duplicate IP address in the list 指定的安全IP列表无效。其中包含重复值。
400 InvalidSecurityIPList.QuotaExceeded Specified security IP list is not valid: Exceeding the allowed amount of IP address in the list. 指定的安全IP列表中包含的IP地址数超过允许上限。SecurityIPList支持最多1000个IP地址。
400 InvalidDBInstanceDescription.Format Specified DB instance description is not valid. 参数DBInstanceDescription无效,请检查参数正确性。参数需符合以下规则:长度为2~256个字符。以中文、英文字母开头,可以包含数字、中文、英文、下划线(_)、短横线(-)。
400 InvalidStorage.Format Specified Storage is not valid. Storage参数值无效。请设置合理的参数取值。
400 InvalidDBInstanceConnType.Format Specified DB instance conn type is not valid. 操作失败,当前数据库实例的连接类型不支持此操作。
400 PreCheckInvalid CreateDdrInstance PreCheck Is Invalid 跨地域恢复数据到新实例(CreateDdrInstance)预检查无效。
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 NoBaksetName BaksetName is absence. 操作失败,备份集名称不存在。
400 NoSourceInstanceName No SourceDBInstanceName. 操作失败,没有源实例名称。
400 NoAvailableDisasterRestoreBakset No available disaster restore bakset. 操作失败,当前没有可用的恢复集。
400 InvalidBackupType.Format Specified backup type is not valid. 操作失败,指定的备份类型无效。
400 IncorrectEngineVersion Current engine version does not support operations. 操作失败,当前数据库版本不支持此操作。
403 IncorrectBackupSetMethod Current backup set method does not support operations. 操作失败,指定的备份集不支持库表恢复。
403 IncorrectBaksetVersion Current bakset version does not support operations. 操作失败,当前备份集(bakset)版本不支持。
404 InvalidRegion.NotFound Specified Region does not exist in the RDS 地域无效。
404 InvalidClusterName.NotFound The specified cluster name is not available. 操作失败,集群名称不存在。请检查集群名称后重试。
404 InvalidDBInstanceClass.NotFound Specified DB instance class is not found. 当前选择的配置或规格不存在或已停售,请重新选择。
404 InvalidDBInstanceNetType.NotFound Specified DB instance net type is not found. 操作失败,实例网络类型不正确。请检查网络类型。
404 RestoreType.NotFound RestoreType is not found. 恢复方式(RestoreType)未找到。
404 InvalidBackupSetID.NotFound Specified backup set ID does not exist. 备份集不存在。请查看已存在的备份集。

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