Restores the data of an original instance to a new instance. The new instance is called a cloned instance.
Operation Description
Before you call this operation, make sure that the following requirements are met:
- The original instance is in the Running state.
- The original instance does not have ongoing migration tasks.
- The log backup feature is enabled for the original instance to support point-in-time recovery.
- If you want to clone the original instance by using backup sets, the original instance must have at least one backup set.
Take note of the following information:
- The new instance has the same IP address whitelist, SQL Explorer (SQL Audit), alert threshold, backup, and parameter settings as the original instance.
- The data and account information of the new instance is the same as that indicated by the backup set or point in time used for restoration of the original instance.
debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action
policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resources
is used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
rds:CloneDBInstance | WRITE |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
RegionId | string | No | The region ID of the new instance. You can call the DescribeRegions operation to query the most recent region list. | cn-hangzhou |
ZoneId | string | No | The zone ID of the primary instance. You can call the DescribeRegions operation to query the most recent zone list. Note
By default, the new instance resides in the same region as the original instance.
| cn-hangzhou-b |
DBInstanceClass | string | No | The instance type of the new instance. For information, see Primary ApsaraDB RDS instance types. Note
By default, the new instance uses the same instance type as the original primary instance.
| mysql.n1.micro.1 |
DBInstanceStorage | integer | No | The storage capacity of the new instance. Unit: GB. You can increase the storage capacity in increments of 5 GB. For more information, see Primary ApsaraDB RDS instance types. Note
By default, the new instance has the same storage capacity as the original primary instance.
| 1000 |
DbNames | string | No | The name of the database. If you specify more than one database, the value is in the following format: | test1,test2 |
PayType | string | Yes | The billing method of the instance. Valid values:
| Postpaid |
InstanceNetworkType | string | No | The network type of the new instance. Valid values:
Note
By default, the new instance has the same network type as the original primary instance.
| VPC |
DBInstanceId | string | Yes | The ID of the instance. | rm-uf6wjk5xxxxxxxxxx |
BackupId | string | No | The ID of the backup set. You can call the DescribeBackups operation to query the backup sets. Note
You must specify at least one of the BackupId and RestoreTime parameters.
| 902**** |
RestoreTime | string | No | The point in time to which you want to restore data. The point in time must fall within the specified backup retention period. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. Note
You must specify at least one of the BackupId and RestoreTime parameters.
| 2011-06-11T16:00:00Z |
VPCId | string | No | The ID of the virtual private cloud (VPC). Note
Make sure that the VPC belongs to the required region.
| vpc-uf6f7l4fg90xxxxxxxxxx |
VSwitchId | string | No | The ID of the vSwitch. The vSwitch must belong to the zone that is specified by the ZoneId parameter. Note
| vsw-uf6adz52c2pxxxxxxxxxx |
PrivateIpAddress | string | No | The internal IP address of the new instance, which must be within the CIDR block supported by the specified vSwitch. The system automatically assigns an internal IP address based on the values of the VPCId and VSwitchId parameters. | 172.XX.XXX.69 |
UsedTime | integer | No | The subscription duration of the new instance. Valid values:
Note
If you set the PayType parameter to Prepaid, you must also specify this parameter.
| 1 |
Period | string | No | The unit that is used to calculate the billing cycle of the new instance. Valid values:
Note
If you set the PayType parameter to Prepaid, you must also specify this parameter.
| Year |
Category | string | No | The RDS edition of the instance. Valid values:
Serverless instance
Note
You do not need to configure this parameter. The value of this parameter is the same as that of the original instance.
| HighAvailability |
ZoneIdSlave1 | string | No | The zone ID of the secondary instance. If you set the ZoneIdSlave1 parameter and the ZoneId parameter to the same value, the single-zone deployment method is used. If you set the ZoneIdSlave1 parameter and the ZoneId parameter to different values, the multi-zone deployment method is used. | cn-hangzhou-c |
ZoneIdSlave2 | string | No | The zone ID of the logger instance. If you set the ZoneIdSlave2 parameter to the same value as the ZoneId parameter, the single-zone deployment method is used. If you set the ZoneIdSlave2 parameter to a different value from the ZoneId parameter, the multi-zone deployment method is used. | cn-hangzhou-d |
DBInstanceStorageType | string | Yes | The storage type of the instance. Valid values:
Note
Serverless instances support only ESSDs of PL 1. For a serverless instance, you must set this parameter to cloud_essd.
| cloud_essd |
RestoreTable | string | No | Specifies whether to restore only the databases and tables that you specify. The value 1 specifies to restore only the specified databases and tables. If you do not want to restore only the specified databases or tables, you do not need to specify this parameter. | 1 |
TableMeta | string | No | The information about the database and table that you want to restore. The value is in the following format: | [{"type":"db","name":"testdb1","newname":"testdb1_new","tables":[{"type":"table","name":"testdb1table1","newname":"testdb1table1_new"}]}] |
DedicatedHostGroupId | string | No | The ID of the dedicated cluster. | dhg-7a9xxxxxxxx |
BackupType | string | No | The type of backup that is used to restore the data of the original instance. Valid values:
| FullBackup |
DeletionProtection | boolean | No | Specifies whether to enable the release protection feature for the instance. Valid values:
| true |
ServerlessConfig | object | No | The configuration of the serverless instance. You must specify this parameter only when you restore data to a new serverless instance. | |
AutoPause | boolean | No | Specifies whether to enable the automatic start and stop feature for the serverless ApsaraDB RDS for MySQL instance. After the automatic start and stop feature is enabled, if no connections to the instance are established within 10 minutes, the instance is suspended. After a connection is established to the instance, the instance is automatically resumed. Valid values:
Note
This parameter is supported only for serverless ApsaraDB RDS for MySQL instances.
| true |
MaxCapacity | double | No | The maximum number of RDS Capacity Units (RCUs). Valid values:
Note
The value of this parameter must be greater than or equal to the value of MinCapacity and can be specified only to an integer.
| 8 |
MinCapacity | double | No | The minimum number of RCUs. Valid values:
Note
The value of this parameter must be less than or equal to the value of MaxCapacity.
| 0.5 |
SwitchForce | boolean | No | Specifies whether to enable the forced scaling feature for the serverless ApsaraDB RDS for MySQL instance. In most cases, ApsaraDB RDS automatically scales in or out the RCUs of a serverless instance based on business requirements in real time. In rare cases, the scaling does not take effect in real time. You can enable the forced scaling feature to forcefully scales in or out the RCUs of the instance. Valid values:
Note
This parameter is supported only for serverless ApsaraDB RDS for MySQL instances.
| false |
BpeEnabled | string | No | A reserved parameter. You do not need to specify this parameter. | false |
BurstingEnabled | boolean | No | A reserved parameter. You do not need to specify this parameter. | false |
AutoPay | boolean | No | Specifies whether to automatically complete the payment. Valid values:
Note
The default value is true. If your account balance is insufficient, you can set AutoPay to false to generate an unpaid order. Then, you can pay for the order in the ApsaraDB RDS console.
| true |
Response parameters
Examples
Sample success responses
JSON
format
{
"DBInstanceId": "rm-uf6wjk5xxxxxxx",
"RequestId": "1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC",
"OrderId": "100789370****"
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | InvalidAvZone.Format | Specified AvZone is not valid. | The value of the AvZone parameter is invalid. Check the value of this parameter. |
400 | InvalidAvZone.NotSupport | Specified availableArea multiZone does not support in RDS. | - |
400 | CannotDecreaseEssdPerfLevel | cannot decrease cloud essd performance level. | The storage type change failed the verification check. The storage type of an RDS instance that runs SQL Server with standard SSDs or ESSDs cannot be changed to local SSDs. |
400 | CannotDecreaseEssdPerfLevel | invalid cloud essd storage size. | The storage capacity is invalid for ESSDs. |
400 | InvalidIPAddress.Conflict | IP address conflict. | - |
400 | CDDC.AvailableHostsNotEnoughInZone | Not enough available hosts are in the target zone. | - |
400 | InvalidInstanceLevel.DiskType | Specified instance level not support request disk type | The current instance type does not support the specified storage 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 | The operation failed. The available storage space of the new RDS instance must be greater than or equal to the total size of data stored in the original RDS instance. |
400 | InvalidDBInstanceClass.Offline | The specified instance type is no longer provided. Please specify another instance type. | The instance type that you select is no longer available. Select another instance type. |
403 | IncorrectMinorVersion | Current engine minor version does not support operations. | This operation is not supported for the current minor engine version. |
403 | IncorrectCharacterType | Current DB instance character type does not support this operation. | This operation is not supported for the character type of the instance. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
2023-07-25 | The error codes of the API operation change. | see changesets | ||||||||||
| ||||||||||||
2023-06-02 | The error codes of the API operation change.,The input parameters of the API operation change. | see changesets | ||||||||||
| ||||||||||||
2022-06-23 | The error codes of the API operation change. | see changesets | ||||||||||
| ||||||||||||
2022-02-10 | The error codes of the API operation change.,The input parameters of the API operation change. | see changesets | ||||||||||
|