调用CloneDBInstance接口将历史数据恢复至一个新实例(称为克隆实例)。

调用该接口时,实例必须满足以下条件,否则将操作失败:

  • 实例状态为运行中;
  • 实例当前没有正在执行的迁移任务;
  • 实例已开启日志备份(用于按时间点恢复);
  • 若要按备份集克隆实例,则主实例必须至少有一个已完成备份的备份集。
    说明 RDS支持RAM子账号创建克隆实例,请务必保证子账号已添加克隆实例的授权策略,添加授权请参见云数据库RDS授权

实例内数据库账号信息克隆以及其他功能的设置克隆将遵循如下方式:

  • 实例内的白名单设置、SQL审计设置、阈值报警设置、备份设置、参数设置将和当前实例状态保持一致;
  • 实例内的数据信息、账号信息与备份文件或时间点当时信息一致。

调试

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

请求参数

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

系统规定参数,取值:CloneDBInstance

PayType String Postpaid

付费类型,取值:

  • Postpaid:后付费(按量付费);
  • Prepaid:预付费(包年包月)。
DBInstanceStorageType String cloud_essd

实例存储类型,取值:

  • local_ssd/ephemeral_ssd:本地SSD盘;
  • cloud_ssd:SSD云盘;
  • cloud_essd:ESSD云盘。
RegionId String cn-hangzhou

地域ID,可以通过接口DescribeRegions查看可用的地域ID。

ZoneId String cn-hangzhou-b

可用区ID。

DBInstanceClass String mysql.n1.micro.1

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

说明 默认规格和主实例一致。
DBInstanceStorage Integer 1000

实例存储空间,单位:GB。每5GB进行递增,详见实例规格表

说明 默认存储空间和主实例一致。
DbNames String testDB

数据库名称。

InstanceNetworkType String VPC

实例的网络类型,取值:

  • VPC:专有网络;
  • Classic:经典网络。
说明 默认网络类型和主实例一致。
BackupId String 9026262

备份集ID。

您可以通过DescribeBackups接口获取备份列表。

说明 BackupIdRestoreTime两者至少传入一个。
DBInstanceId String rm-uf6wjk5xxxxxxxxxx

实例ID。

RestoreTime String 2011-06-11T16:00:00Z

备份保留周期内的任意时间点。格式:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

说明 BackupIdRestoreTime两者至少传入一个。
VPCId String vpc-uf6f7l4fg90xxxxxxxxxx

VPC ID。

VSwitchId String vsw-uf6adz52c2pxxxxxxxxxx

VSwitch ID。

PrivateIpAddress String 172.16.201.69

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

UsedTime String 1

购买时长,取值:

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

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

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

实例系列,取值:

  • Basic:基础版;
  • HighAvailability:高可用版;
  • AlwaysOn:集群版;
  • Finance:金融版(仅中国站支持)。
RestoreTable String 1

是否进行库表恢复,取值为1时表示进行库表恢复,否则不填。

TableMeta String [{"type":"db","name":"testdb1","newname":"testdb1_new","tables":[{"type":"table","name":"testdb1table1","newname":"testdb1table1_new"}]}]

进行库表恢复时,指定恢复的库表信息。格式:

[{"type":"db","name":"<数据库1名称>","newname":"<新数据库1名称>","tables":[{"type":"table","name":"<数据库1内的表1名称>","newname":"<新的表1名称>"},{"type":"table","name":"<数据库1内的表2名称>","newname":"<新的表2名称>"}]},{"type":"db","name":"<数据库1名称>","newname":"<新数据库2名称>","tables":[{"type":"table","name":"<数据库2内的表3名称>","newname":"<新的表3名称>"},{"type":"table","name":"<数据库2内的表4名称>","newname":"<新的表4名称>"}]}]

返回数据

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

实例ID。

OrderId String 100789370xxxxx

订单ID。

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

请求ID。

示例

请求示例


http(s)://rds.aliyuncs.com/?Action=CloneDBInstance
&BackupId=9026262
&PayType=Postpaid
&<公共请求参数>

正常返回示例

XML 格式

<CloneDBInstanceResponse>
	  <OrderId>100789370xxxxx</OrderId>
	  <DBInstanceId>rm-uf6wjk5xxxxxxx</DBInstanceId>
	  <RequestId>1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC</RequestId></CloneDBInstanceResponse>

JSON 格式

{
	"RequestId":"1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC",
	"DBInstanceId":"rm-uf6wjk5xxxxxxx",
	"OrderId":"100789370xxxxx"
}

错误码

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