首页 云数据库 RDS API参考 API目录 跨地域备份恢复 CreateDdrInstance - 跨地域恢复数据到新实例

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

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

接口说明

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

仅适用于如下实例类型：

调试

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

调试

授权信息

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

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

请求参数

名称类型必填描述示例值
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:// 开头。
测试数据库
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字符。

ETnLKlblzczshOTUbOCzxxxxxxxxxx
PayTypestring是

目标实例的付费类型，取值：

  • Postpaid：后付费（按量付费）
  • Prepaid：预付费（包年包月）
Prepaid
ZoneIdstring否

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

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

目标实例的网络类型，取值：

  • VPC：VPC网络
  • Classic：经典网络

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

说明当本参数值为VPC时，还需要传入参数VpcId、VSwitchId。
Classic
ConnectionModestring否

目标实例的访问模式，取值：

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

默认值：Standard。

Standard
VPCIdstring否

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

说明如果传入此参数，您还需要传入参数ZoneId。
vpc-xxxxxxxxxxxx
VSwitchIdstring否

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

说明如果传入此参数，您还需要传入参数ZoneId。
vsw-xxxxxxxxxxx
PrivateIpAddressstring否

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

172.XXX.XXX.69
UsedTimestring否

指定购买时长，取值：

  • 当参数Period为Year时，UsedTime取值为1~3。
  • 当参数Period为Month时，UsedTime取值为1~9。
说明若付费类型为Prepaid则该参数必须传入。
2
Periodstring否

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

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

资源组ID。

rg-acfmyxxxxxxxxxx
RestoreTypestring是

恢复方式，取值：

  • BackupSet：基于备份集恢复，您还需要传入参数BackupSetId。
  • BackupTime：基于时间点恢复，您还需要传入参数RestoreTime、SourceRegion、SourceDBInstanceName。
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-uf6wjk5xxxxxxx
DBInstanceStorageTypestring否

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

local_ssd

返回参数

名称类型描述示例值
object

返回参数详情如下。

DBInstanceIdstring

新实例ID。

rm-xxxxx
RequestIdstring

请求ID。

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

新实例连接端口。

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

新实例连接地址。

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

订单ID。

2038691xxxxx

示例

正常返回示例

JSON格式

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

错误码

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.-
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备份集。
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.备份集不存在。请查看已存在的备份集。

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

变更历史

变更时间变更内容概要操作
2023-01-11OpenAPI 错误码发生变更
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码：400
    删除错误码：403
    删除错误码：404
2022-09-01OpenAPI 错误码发生变更
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码：403
    删除错误码：404
阿里云首页 关系型数据库 相关技术圈