CreateDdrInstance
调用CreateDdrInstance接口跨地域恢复数据到新实例。
恢复前可以调用CheckCreateDdrDBInstance接口预检查某RDS实例是否可以用跨地域备份集进行跨地域恢复。
仅适用于如下实例:
- MySQL 8.0高可用版(本地SSD盘)
- MySQL 5.7高可用版(本地SSD盘)
- MySQL 5.6
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | CreateDdrInstance |
系统规定参数,取值:CreateDdrInstance。 |
RegionId | String | 是 | cn-hangzhou |
目标地域ID,可以通过接口DescribeRegions查看地域ID。 |
Engine | String | 是 | MySQL |
目标数据库类型,取值:MySQL。 |
EngineVersion | String | 是 | 5.6 |
目标数据库版本,取值:
|
DBInstanceClass | String | 是 | rds.mysql.s1.small |
目标实例规格,详见实例规格表。 |
DBInstanceStorage | Integer | 是 | 20 |
目标实例存储空间,取值: 5~2000。 每5G进行递增,单位:GB。详见实例规格表。 |
DBInstanceNetType | String | 是 | Intranet |
目标实例的网络连接类型,取值:
|
PayType | String | 是 | Prepaid |
目标实例的付费类型,取值:
|
RestoreType | String | 是 | 0 |
恢复方式,取值:
|
SecurityIPList | String | 是 | 127.0.0.1 |
目标实例的IP白名单,多个IP地址请以英文逗号(,)隔开,不可重复,最多1000个。支持如下两种格式:
|
InstanceNetworkType | String | 否 | Classic |
目标实例的网络类型,取值:
默认创建经典网络类型的实例。 说明 当本参数值为 VPC时,还需要传入参数VpcId、VSwitchId。
|
ZoneId | String | 否 | cn-hangzhou-b |
目标实例的可用区ID。多可用区用英文冒号(:)分隔。 说明 指定了VPC和交换机时,为匹配交换机对应的可用区,该参数必填。
|
VPCId | String | 否 | vpc-xxxxxxxxxxxx |
目标的实例的VPC ID。当InstanceNetworkType=VPC时,本参数可用。 说明 如果传入此参数,您还需要传入参数ZoneId。
|
DBInstanceStorageType | String | 否 | local_ssd |
目标实例存储类型,当前仅支持SSD本地盘,默认值:local_ssd。 |
VSwitchId | String | 否 | vsw-xxxxxxxxxxx |
目标实例的虚拟交换机ID,多个值用英文逗号(,)隔开。当InstanceNetworkType=VPC时,本参数可用。 说明 如果传入此参数,您还需要传入参数ZoneId。
|
AccessKeyId | String | 否 | LTAIfCxxxxxxx |
阿里云颁发给用户的访问服务所用的密钥ID。 |
ConnectionMode | String | 否 | Standard |
目标实例的访问模式,取值:
默认值:Standard。 |
SystemDBCharset | String | 否 | uft8 |
目标实例的字符集,取值:
|
DBInstanceDescription | String | 否 | 测试数据库 |
目标实例名称,长度为2~256个字符。以中文、英文字母开头,可以包含数字、中文、英文、下划线(_)、短横线(-)。 说明 不能以 http:// 和 https:// 开头。
|
ClientToken | String | 否 | ETnLKlblzczshOTUbOCzxxxxxxxxxx |
用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符,且该参数值中不能包含非ASCII字符。 |
PrivateIpAddress | String | 否 | 172.16.201.69 |
设置目标实例的内网IP,需要在指定交换机的IP地址范围内。系统默认通过VPCId和VSwitchId自动分配。 |
Period | String | 否 | Year |
指定预付费目标实例为包年或者包月类型,取值:
说明 若付费类型为Prepaid则该参数必须传入。
|
BackupSetId | String | 否 | 14358 |
基于备份集恢复时,使用的备份集的ID。可以通过接口DescribeCrossRegionBackups查看备份集ID。 说明 RestoreType=0时必传。
|
SourceDBInstanceName | String | 否 | rm-uf6wjk5xxxxxxx |
基于时间点恢复时,源实例的ID。 说明 RestoreType=1时必传。
|
SourceRegion | String | 否 | cn-hangzhou |
基于时间点恢复时,源地域的ID。 说明 RestoreType=1时必传。
|
RestoreTime | String | 否 | 2019-05-30T03:29:10Z |
基于时间点恢复时,要恢复的时间节点,需要早于当前时间。格式:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。 说明 RestoreType=1时必传 。
|
UsedTime | String | 否 | 2 |
指定购买时长,取值:
说明 若付费类型为Prepaid则该参数必须传入。
|
ResourceGroupId | String | 否 | rg-acfmyxxxxxxxxxx |
资源组ID。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
DBInstanceId | String | rm-xxxxx |
新实例ID。 |
ConnectionString | String | rm-xxxxx.mysql.rds.aliyuncs.com |
新实例连接地址。 说明 参数DBInstanceNetType决定该地址为内网或外网。
|
OrderId | String | 2038691xxxxx |
订单ID。 |
Port | String | 3306 |
新实例连接端口。 说明 参数DBInstanceNetType决定该端口为内网端口或外网端口。
|
RequestId | String | E52666CC-330E-418A-8E5B-A19E3FB42D13 |
请求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
格式
<CreateDdrInstanceResponse>
<ConnectionString>rm-xxxxx.mysql.rds.aliyuncs.com</ConnectionString>
<Port>3306</Port>
<RequestId>E52666CC-330E-418A-8E5B-A19E3FB42D13</RequestId>
<DBInstanceId>rm-xxxxx</DBInstanceId>
<OrderId>2038691xxxxx</OrderId>
</CreateDdrInstanceResponse>
JSON
格式
{
"Port":"3306",
"ConnectionString":"rm-xxxxx.mysql.rds.aliyuncs.com",
"OrderId":"2038691xxxxx",
"DBInstanceId":"rm-xxxxx",
"RequestId":"E52666CC-330E-418A-8E5B-A19E3FB42D13"
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidZoneId.NotSupported | The Specified vpc Zone not supported. | 当前可用区不支持生产 VPC 实例,请您更换可用区再试。 |
400 | InvalidDBInstanceName.Format | Specified DB instance name is not valid. | 指定的DB实例名不正确。 |
400 | InvalidServiceType.Format | Specified service type is not valid. | 指定的服务类型无效。 |
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. | 指定的连接字符串无效。 |
400 | InvalidConnectionString.Duplicate | Specified connection string already exists in the Aliyun RDS. | 在阿里云RDS中已经存在指定的连接字符串。 |
400 | InvalidCharacterSetName.Format | Specified character set name is not valid. | 指定的字符集名称无效。 |
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. | 指定的备份保留期无效。 |
400 | InvalidPreferredBackupTime.Format | Specified preferred backup time is not valid. | 指定的期望备份时间无效。 |
400 | InvalidPreferredBackupPeriod.Malformed | Specified backup period is not valid. | 指定的期望备份时间无效。 |
404 | InvalidDBInstanceClass.NotFound | Specified DB instance class is not found. | 实例规格无效,请检查该参数是否正确。 |
404 | InvalidDBInstanceNetType.NotFound | Specified DB instance net type is not found. | 指定DB实例网络类型不存在。 |
400 | InvalidOptmizationService | Specified optmization service is not valid. | 参数OptmizationService无效 |
400 | InvalidExpiredTime.Format | Specified expired time is not valid. | 指定的失效时间不正确。 |
400 | InvalidSecurityIPList.Format | Specified security IP list format is not valid. | 指定的安全IP列表格式不正确。 |
400 | InvalidSecurityIPList.QuotaExceeded | Specified security IP list is not valid: Exceeding the allowed amount of IP address in the list. | 指定的安全IP列表中包含的IP地址数超过允许上限。 |
400 | InvalidDBInstanceDescription.Format | Specified DB instance description is not valid. | 指定的DB实例描述无效。 |
400 | InvalidStorage.Format | Specified Storage is not valid. | 指定的Storage参数无效。 |
400 | IncorrectDBInstanceType | Current DB instance engine and type does not support operations. | 当前DB实例引擎和类型不支持操作。 |
400 | InvalidRestoreType.Format | Specified restore type is not valid. | 指定的恢复类型无效。 |
400 | InvalidBackupType.Format | Specified backup type is not valid. | 指定的备份类型无效。 |
访问错误中心查看更多错误码。
版权声明
本文仅代表作者观点,不代表本站立场。
本文系作者授权发表,未经许可,不得转载。
评论