备案控制台
文档
产品文档
输入文档关键字查找
首页 云数据库 RDS 开发参考 API参考 API目录 恢复 CloneDBInstance - 恢复数据（克隆实例）

CloneDBInstance - 恢复数据（克隆实例）

更新时间：
一键部署
产品详情
相关技术圈
我的收藏

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

接口说明

适用引擎

  • 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 接口获取备份列表。

说明 BackupId 和 RestoreTime 两者至少传入一个。
902****
RestoreTimestring否

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

说明 BackupId 和 RestoreTime 两者至少传入一个。
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 地址范围内。系统默认通过 VPCId 和 VSwitchId 自动分配。

172.XX.XX.69
UsedTimeinteger否

购买时长，取值：

  • 当参数 Period 为 Year 时，UsedTime 取值为1~3。
  • 当参数 Period 为 Month 时，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否

    弃用参数，无需配置。

    		0
    IoAccelerationEnabledstring否

    是否开启通用云盘 IO 加速功能，参数取值含义如下：

    • 1：开启
    • 0：不开启
    说明 通用云盘的 IO 加速功能的更多信息，请参见通用云盘 IO 加速功能技术介绍。
    		0
    BurstingEnabledboolean否

    通用云盘 IO 突发功能开关。

    • true：开启 IO 突发功能。
    • false：关闭 IO 突发功能。
    说明 了解通用云盘的 IO 突发功能的更多信息，请参见什么是通用云盘。
    		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.指定的连接通道无效。
    400Order.ComboInstanceNotAllowOperateA package instance is not allowed to operate independently.套餐实例不允许单独操作。
    400Price.PricingPlanResultNotFoundPricing plan price result not found.定价计划价格结果没有找到。
    400Order.NoRealNameAuthenticationYou have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.您还未通过实名认证，不符合购买条件，请登录用户中心进行实名认证。
    400InsufficientAvailableQuotaYour account quota limit is less than 0, please recharge before trying to purchase.您的账户可用额度小于0，请先充值后再尝试购买。
    400CommodityServiceCalling.ExceptionFailed to call commodity service.调用商品服务返回失败。
    400RegionDissolvedEOMDear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.客户您好，阿里云计划对当前地域进行优化调整，该区域云服务将停止运营，为确保您的业务连续性及数据迁移工作的平稳过渡，您目前无法操作新购类型的订单，感谢理解与支持。
    400Commodity.InvalidComponentThe module you purchased is not legal, please buy it again.您购买的模块不合法，请重新购买。
    400RegionEndTimeDissolvedIndiaCloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.客户您好，印度地域裁撤，购买的服务效期不能超过2024.07.15。
    400RegionEndTimeDissolvedAustraliaCloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.客户您好，澳洲地域裁撤，购买的服务效期不能超过2024.09.30
    400Price.CommoditySysCommodity system call exception.商品系统调用异常。
    400Pay.InsufficientBalanceInsufficient available balance.可用金不足。
    400Order.PeriodInvalidThere is a problem with the period you selected, please choose again.您选购的周期有问题，请重新选购。
    400pay.noCreditCardAccount not bound to credit card.账户未绑定信用卡。
    400Order.InstHasUnpaidOrderThere is an unpaid order for the service you have purchased. Please pay or void it before placing the order.您选购的服务存在未支付订单，请支付或作废后再下单。
    400noAvailablePaymentMethodNo payment method is specified for your account. We recommend that you add a payment method.没有为您的帐户指定付款方式。我们建议您添加一种付款方式。
    400BasicInfoUncompletedYour information is incomplete. Complete your information before the operation.您的基本信息未完善，请在操作前先完善您的基本信息。
    400Risk.RiskControlRejectionYour account is abnormal, please contact customer service for details.您的账户出现异常，详情请联系客服。
    400BasicInfoUncompletedYour information is incomplete, Complete your information before the operation.您的信息不完整，请在操作前填写您的信息。
    400System.SaleValidateFailedSales expression validation system error.销售表达式校验系统错误。
    403IncorrectMinorVersionCurrent engine minor version does not support operations.当前引擎小版本不支持此操作。
    403IncorrectCharacterTypeCurrent DB instance character type does not support this operation.当前实例字符类型不支持此操作。
    403OrderStatus.UnPaidThe specified db instance has unpaid order.实例当前存在未支付订单，请支付后重试。
    404InvalidDBInstance.NotFoundThe specified instance does not exist or is not supported.没有找到指定的实例，请检查实例的正确性。

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

    变更历史

    变更时间变更内容概要操作
    2024-01-04OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更。
      删除错误码：400
      删除错误码：403
      删除错误码：404
    入参OpenAPI 入参发生变更。
      新增入参：IoAccelerationEnabled
      新增入参：BurstingEnabled
    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
    文档推荐
    • 本页导读 （1）
    文档反馈