该接口用于将历史数据恢复至一个新实例(称为克隆实例)。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
rds:CloneDBInstance | Write |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 否 | 地域ID。可以通过接口DescribeRegions查看地域ID。 | cn-hangzhou |
ZoneId | string | 否 | 主可用区ID。可以通过接口DescribeRegions查看可用区ID。 说明
默认为源实例的可用区。
| cn-hangzhou-b |
DBInstanceClass | string | 否 | 实例规格,详见实例规格表。 说明
默认规格和主实例一致。
| mysql.n1.micro.1 |
DBInstanceStorage | integer | 否 | 实例存储空间,单位:GB。每5GB进行递增,详见实例规格表。 说明
默认存储空间和主实例一致。
| 1000 |
DbNames | string | 否 | 数据库名称,格式如下: | test1,test2 |
PayType | string | 是 | 付费类型,取值:
| Postpaid |
InstanceNetworkType | string | 否 | 实例的网络类型,取值:
说明
默认网络类型和主实例一致。
| VPC |
DBInstanceId | string | 是 | 实例ID。 | rm-uf6wjk5**** |
BackupId | string | 否 | 备份集ID。 您可以通过DescribeBackups接口获取备份列表。 说明
BackupId和RestoreTime两者至少传入一个。
| 902**** |
RestoreTime | string | 否 | 备份保留周期内的任意时间点。格式:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。 说明
BackupId和RestoreTime两者至少传入一个。
| 2011-06-11T16:00:00Z |
VPCId | string | 否 | 专有网络VPC ID。 说明
请确保VPC属于对应的地域。
| vpc-uf6f7l4fg90**** |
VSwitchId | string | 否 | 虚拟交换机ID。虚拟交换机所在的可用区必须和ZoneId中传入的可用区ID相对应。
| vsw-uf6adz52c2p**** |
PrivateIpAddress | string | 否 | 新实例的内网IP,需要在指定交换机的IP地址范围内。系统默认通过VPCId和VSwitchId自动分配。 | 172.XX.XX.69 |
UsedTime | integer | 否 | 购买时长,取值:
说明
若付费类型为Prepaid则该参数必须传入。
| 1 |
Period | string | 否 | 预付费实例为包年或者包月类型,取值:
说明
若付费类型为Prepaid则该参数必须传入。
| Year |
Category | string | 否 | 实例系列,取值:
Serverless实例
说明
该参数不需要传递,克隆时会保持和源实例相同。
| HighAvailability |
ZoneIdSlave1 | string | 否 | 备节点可用区ID。如果和ZoneId相同,则为单可用区部署;如果和ZoneId不同,则为多可用区部署。 | cn-hangzhou-c |
ZoneIdSlave2 | string | 否 | 备节点或日志节点可用区ID。如果和ZoneId相同,则为单可用区部署;如果和ZoneId不同,则为多可用区部署。 | cn-hangzhou-d |
DBInstanceStorageType | string | 是 | 实例存储类型,取值:
说明
Serverless实例仅支持ESSD PL1云盘,必须传入cloud_essd。
| cloud_essd |
RestoreTable | string | 否 | 是否进行库表恢复,取值为1时表示进行库表恢复,否则不填。 | 1 |
TableMeta | string | 否 | 进行库表恢复时,指定恢复的库表信息。格式:
| [{"type":"db","name":"testdb1","newname":"testdb1_new","tables":[{"type":"table","name":"testdb1table1","newname":"testdb1table1_new"}]}] |
DedicatedHostGroupId | string | 否 | 专属集群ID。 | dhg-7a9**** |
BackupType | string | 否 | 备份类型,取值:
| FullBackup |
DeletionProtection | boolean | 否 | 是否开启释放保护功能。取值:
| true |
ServerlessConfig | object | 否 | Serverless选项。仅在需要将数据克隆至Serverless实例时传入。 | |
AutoPause | boolean | 否 | 是否开启MySQL Serverless实例的自动启停功能。10分钟无任何连接进入暂停状态,连接进入时会自动唤醒。取值:
说明
仅MySQL Serverless实例支持该参数。
| true |
MaxCapacity | double | 否 | 实例RCU(RDS Capacity Unit)的自动扩缩范围最大值。取值:
说明
该参数的值必须大于等于MinCapacity,且仅支持传入整数。
| 8 |
MinCapacity | double | 否 | 实例RCU(RDS Capacity Unit)的自动扩缩范围最小值。取值:
说明
该参数的值必须小于等于MaxCapacity。
| 0.5 |
SwitchForce | boolean | 否 | 是否开启MySQL Serverless实例的强制弹性扩缩容。实例RCU的弹性扩缩容通常会立刻生效,但在某些特殊情况下无法即时完成扩缩容,此时可开启本参数进行强制扩缩容。取值:
说明
仅MySQL Serverless实例支持该参数。
| false |
BpeEnabled | string | 否 | 预留参数,无需配置。 | false |
BurstingEnabled | boolean | 否 | 预留参数,无需配置。 | false |
AutoPay | boolean | 否 | 是否自动支付。 取值范围:
说明
默认值为true。如果您的支付方式余额不足,可以将参数AutoPay设置为false,此时会生成未支付订单,您可以登录RDS管理控制台自行支付。
| true |
返回参数
示例
正常返回示例
JSON
格式
{
"DBInstanceId": "rm-uf6wjk5****",
"RequestId": "1E43AAE0-BEE8-43DA-860D-EAF2****",
"OrderId": "100789370****"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidAvZone.Format | Specified AvZone is not valid. | 指定的AvZone不合法,请检查该参数的正确性。 |
400 | InvalidAvZone.NotSupport | Specified availableArea multiZone does not support in RDS. | 指定的availableArea multiZone在RDS中不支持。 |
400 | CannotDecreaseEssdPerfLevel | cannot decrease cloud essd performance level. | 存储类型变更校验失败,SQL Server云盘实例只能转为云盘,SSD只能升级到SSD或ESSD。 |
400 | CannotDecreaseEssdPerfLevel | invalid cloud essd storage size. | 云essd存储大小无效。 |
400 | InvalidIPAddress.Conflict | IP address conflict. | IP地址冲突。 |
400 | CDDC.AvailableHostsNotEnoughInZone | Not enough available hosts are in the target zone. | 目标可用区没有足够的主机资源,请在可用区中创建主机。 |
400 | InvalidInstanceLevel.DiskType | Specified instance level not support request disk type | 当前实例规格不支持该存储类型。 |
400 | InvalidRecoveryDbInstance.StorageType | The disk local_ssd can not clone to cloud disk type | 本地盘无法克隆为云盘 |
400 | InvalidRecoveryDbInstance.StorageSize | The disk space of the new instance cannot be less than that of the current instance | 操作失败,新实例的磁盘空间不能小于当前实例的空间。 |
400 | InvalidDBInstanceClass.Offline | The specified instance type is no longer provided. Please specify another instance type. | 当前所选的实例规格已下线,请更换其他实例规格。 |
400 | InvalidTunnelId | Specified conn tunnel is not valid. | 指定的连接通道无效。 |
403 | IncorrectMinorVersion | Current engine minor version does not support operations. | 当前引擎小版本不支持此操作。 |
403 | IncorrectCharacterType | Current DB instance character type does not support this operation. | 当前实例字符类型不支持此操作。 |
404 | InvalidDBInstance.NotFound | The specified instance does not exist or is not supported. | 没有找到指定的实例,请检查实例的正确性。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
2023-11-21 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||||
| ||||||||||||
2023-11-17 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||||
| ||||||||||||
2023-07-25 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||||
| ||||||||||||
2023-06-02 | OpenAPI 错误码发生变更,OpenAPI 入参发生变更 | 看变更集 | ||||||||||
| ||||||||||||
2022-06-23 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||||
| ||||||||||||
2022-02-10 | OpenAPI 错误码发生变更,OpenAPI 入参发生变更 | 看变更集 | ||||||||||
|