首页 云数据库 RDS 开发参考 API参考 API目录 恢复 CloneDBInstance - 恢复数据(克隆实例)

CloneDBInstance - 恢复数据(克隆实例)

更新时间: 2023-11-30 12:22:36

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

接口说明

适用引擎

  • RDS MySQL
  • RDS PostgreSQL
  • RDS SQL Server
  • RDS MariaDB

相关功能文档

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

调试

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

调试

授权信息

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

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

请求参数

名称类型必填描述示例值
RegionIdstring

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

cn-hangzhou
ZoneIdstring

主可用区ID。可以通过接口DescribeRegions查看可用区ID。

说明 默认为源实例的可用区。
cn-hangzhou-b
DBInstanceClassstring

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

说明 默认规格和主实例一致。
mysql.n1.micro.1
DBInstanceStorageinteger

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

说明 默认存储空间和主实例一致。
1000
DbNamesstring

数据库名称,格式如下:原库名1,原库名2

test1,test2
PayTypestring

付费类型,取值:

Postpaid
InstanceNetworkTypestring

实例的网络类型,取值:

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

实例ID。

rm-uf6wjk5****
BackupIdstring

备份集ID。

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

说明 BackupIdRestoreTime两者至少传入一个。
902****
RestoreTimestring

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

说明 BackupIdRestoreTime两者至少传入一个。
2011-06-11T16:00:00Z
VPCIdstring

专有网络VPC ID。

说明 请确保VPC属于对应的地域。
vpc-uf6f7l4fg90****
VSwitchIdstring

虚拟交换机ID。虚拟交换机所在的可用区必须和ZoneId中传入的可用区ID相对应。

  • 网络类型InstanceNetworkType需为VPC
  • 若您填写了ZoneSlaveId1(备可用区ID),此处需填写两个交换机ID,并使用半角逗号(,)隔开。
vsw-uf6adz52c2p****
PrivateIpAddressstring

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

172.XX.XX.69
UsedTimeinteger

购买时长,取值:

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

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

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

实例系列,取值:

  • Basic:基础系列
  • HighAvailability:高可用系列
  • AlwaysOn:集群系列(SQL Server)
  • cluster:集群系列(MySQL)
  • Finance:金融版(仅中国站支持)

Serverless实例

  • serverless_basic:Serverless基础系列(仅适用MySQL和PostgreSQL)
  • serverless_standard:MySQL Serverless高可用系列
  • serverless_ha:SQL Server Serverless高可用系列
说明 该参数不需要传递,克隆时会保持和源实例相同。
HighAvailability
ZoneIdSlave1string

备节点可用区ID。如果和ZoneId相同,则为单可用区部署;如果和ZoneId不同,则为多可用区部署。

cn-hangzhou-c
ZoneIdSlave2string

备节点或日志节点可用区ID。如果和ZoneId相同,则为单可用区部署;如果和ZoneId不同,则为多可用区部署。

cn-hangzhou-d
DBInstanceStorageTypestring

实例存储类型,取值:

  • local_ssd:本地SSD盘
  • cloud_ssd:SSD云盘
  • cloud_essd:ESSD PL1云盘
  • cloud_essd2:ESSD PL2云盘
  • cloud_essd3:ESSD PL3云盘
说明 Serverless实例仅支持ESSD PL1云盘,必须传入cloud_essd
cloud_essd
RestoreTablestring

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

1
TableMetastring

进行库表恢复时,指定恢复的库表信息。格式: [{"type":"db","name":"数据库1名称","newname":"新数据库1名称","tables":[{"type":"table","name":"数据库1内的表1名称","newname":"新的表1名称"},{"type":"table","name":"数据库1内的表2名称","newname":"新的表2名称"}]},{"type":"db","name":"数据库2名称","newname":"新数据库2名称","tables":[{"type":"table","name":"数据库2内的表1名称","newname":"新的表1名称"},{"type":"table","name":"数据库2内的表2名称","newname":"新的表2名称"}]}]

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

专属集群ID。

dhg-7a9****
BackupTypestring

备份类型,取值:

  • FullBackup:全量备份
  • IncrementalBackup:增量备份
FullBackup
DeletionProtectionboolean

是否开启释放保护功能。取值:

  • true:开启
  • false(默认):关闭
true
ServerlessConfigobject

Serverless选项。仅在需要将数据克隆至Serverless实例时传入。

AutoPauseboolean

是否开启MySQL Serverless实例的自动启停功能。10分钟无任何连接进入暂停状态,连接进入时会自动唤醒。取值:

  • true:启用
  • false(默认):不启用
说明 仅MySQL Serverless实例支持该参数。
true
MaxCapacitydouble

实例RCU(RDS Capacity Unit)的自动扩缩范围最大值。取值:

  • MySQL:1~8
  • SQL Server:2~8
  • PostgreSQL:1~12
说明 该参数的值必须大于等于MinCapacity,且仅支持传入整数
8
MinCapacitydouble

实例RCU(RDS Capacity Unit)的自动扩缩范围最小值。取值:

  • MySQL:0.5~8
  • SQL Server:2~8(仅支持整数)
  • PostgreSQL:0.5~12
说明 该参数的值必须小于等于MaxCapacity
0.5
SwitchForceboolean

是否开启MySQL Serverless实例的强制弹性扩缩容。实例RCU的弹性扩缩容通常会立刻生效,但在某些特殊情况下无法即时完成扩缩容,此时可开启本参数进行强制扩缩容。取值:

  • true:启用
  • false(默认):不启用
说明 仅MySQL Serverless实例支持该参数。
false
BpeEnabledstring

预留参数,无需配置。

false
BurstingEnabledboolean

预留参数,无需配置。

false
AutoPayboolean

是否自动支付。 取值范围:

  1. true:自动支付。您需要确保账户余额充足。

  2. false:只生成订单不扣费。

说明 默认值为true。如果您的支付方式余额不足,可以将参数AutoPay设置为false,此时会生成未支付订单,您可以登录RDS管理控制台自行支付。
true

返回参数

名称类型描述示例值
object

返回参数详情。

DBInstanceIdstring

实例ID。

rm-uf6wjk5****
RequestIdstring

请求ID。

1E43AAE0-BEE8-43DA-860D-EAF2****
OrderIdstring

订单ID。

100789370****

示例

正常返回示例

JSON格式

{
  "DBInstanceId": "rm-uf6wjk5****",
  "RequestId": "1E43AAE0-BEE8-43DA-860D-EAF2****",
  "OrderId": "100789370****"
}

错误码

HTTP status code错误码错误信息描述
400InvalidAvZone.FormatSpecified AvZone is not valid.指定的AvZone不合法,请检查该参数的正确性。
400InvalidAvZone.NotSupportSpecified availableArea multiZone does not support in RDS.指定的availableArea multiZone在RDS中不支持。
400CannotDecreaseEssdPerfLevelcannot decrease cloud essd performance level.存储类型变更校验失败,SQL Server云盘实例只能转为云盘,SSD只能升级到SSD或ESSD。
400CannotDecreaseEssdPerfLevelinvalid cloud essd storage size.云essd存储大小无效。
400InvalidIPAddress.ConflictIP address conflict.IP地址冲突。
400CDDC.AvailableHostsNotEnoughInZoneNot enough available hosts are in the target zone.目标可用区没有足够的主机资源,请在可用区中创建主机。
400InvalidInstanceLevel.DiskTypeSpecified instance level not support request disk type当前实例规格不支持该存储类型。
400InvalidRecoveryDbInstance.StorageTypeThe disk local_ssd can not clone to cloud disk type本地盘无法克隆为云盘
400InvalidRecoveryDbInstance.StorageSizeThe disk space of the new instance cannot be less than that of the current instance操作失败,新实例的磁盘空间不能小于当前实例的空间。
400InvalidDBInstanceClass.OfflineThe specified instance type is no longer provided. Please specify another instance type.当前所选的实例规格已下线,请更换其他实例规格。
400InvalidTunnelIdSpecified conn tunnel is not valid.指定的连接通道无效。
403IncorrectMinorVersionCurrent engine minor version does not support operations.当前引擎小版本不支持此操作。
403IncorrectCharacterTypeCurrent DB instance character type does not support this operation.当前实例字符类型不支持此操作。
404InvalidDBInstance.NotFoundThe specified instance does not exist or is not supported.没有找到指定的实例,请检查实例的正确性。

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

变更历史

变更时间变更内容概要操作
2023-11-21OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    新增错误码:404
2023-11-17OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:403
2023-07-25OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:403
2023-06-02OpenAPI 错误码发生变更,OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
入参OpenAPI 入参发生变更
    新增入参:AutoPay
2022-06-23OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
2022-02-10OpenAPI 错误码发生变更,OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
入参OpenAPI 入参发生变更
    新增入参:DeletionProtection
阿里云首页 云数据库 RDS 相关技术圈