This API restores historical data to a new cloned instance.
Operation description
Applicable engines
ApsaraDB RDS for MySQL
ApsaraDB RDS for PostgreSQL
ApsaraDB RDS for SQL Server
ApsaraDB RDS for MariaDB
Related documentation
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
rds:CloneDBInstance |
create |
DBInstance
|
|
None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| ClientToken |
string |
No |
A client-generated token that ensures the idempotence of the request. The token must be unique across requests and can be up to 64 ASCII characters long. |
0c593ea1-3bea-11e9-b96b-88********** |
| RegionId |
string |
No |
The region ID. You can call the DescribeRegions operation to query the latest regions. |
cn-hangzhou |
| ZoneId |
string |
No |
The ID of the primary availability zone. You can call the DescribeRegions operation to query the latest availability zones. Note
Defaults to the availability zone of the source instance. |
cn-hangzhou-b |
| DBInstanceClass |
string |
No |
The instance type of the new instance. For more information, see Instance types. Note
If you do not specify this parameter, the new instance uses the instance type of the source instance. |
mysql.n1.micro.1 |
| DBInstanceStorage |
integer |
No |
The storage capacity of the new instance. Unit: GB. The value must be a multiple of 5. For more information, see Instance types. Note
If you do not specify this parameter, the new instance uses the storage capacity of the source instance. |
1000 |
| DBInstanceDescription |
string |
No |
The description of the instance. The description must be 2 to 255 characters in length. It must start with a letter or a Chinese character, and can contain letters, Chinese characters, digits, underscores (_), and hyphens (-). Note
The description cannot start with |
testInstance |
| DbNames |
string |
No |
The names of the databases that you want to clone. Format: |
test1,test2 |
| PayType |
string |
Yes |
The billing method of the instance. Valid values:
|
Postpaid |
| InstanceNetworkType |
string |
No |
The network type of the instance. Valid values:
Note
By default, the network type of the new instance is the same as that of the source instance. |
VPC |
| DBInstanceId |
string |
Yes |
The instance ID. |
rm-uf6wjk5**** |
| BackupId |
string |
No |
The ID of the backup set. You can call the DescribeBackups operation to query the backup list. Note
You must specify at least one of BackupId and RestoreTime. |
902**** |
| RestoreTime |
string |
No |
The point in time to which you want to restore data. The point in time must be within the backup retention period. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. Note
You must specify at least one of BackupId and RestoreTime. |
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-uf6f7l4fg90**** |
| VSwitchId |
string |
No |
The ID of the vSwitch. The vSwitch must be in the same availability zone as specified by the ZoneId parameter.
|
vsw-uf6adz52c2p**** |
| PrivateIpAddress |
string |
No |
The internal IP address of the new instance. The IP address must be within the CIDR block of the specified vSwitch. The system automatically assigns an IP address based on the VPCId and VSwitchId parameters. |
172.XX.XX.69 |
| UsedTime |
integer |
No |
The subscription duration of the instance. Valid values:
Note
If the PayType parameter is set to Prepaid, you must specify this parameter. |
1 |
| Period |
string |
No |
The unit of the subscription duration. Valid values:
Note
If the PayType parameter is set to Prepaid, you must specify this parameter. |
Year |
| Category |
string |
No |
The edition of the instance. Valid values:
Serverless instances
Note
You do not need to specify this parameter. The new instance is of the same edition as the source instance. |
HighAvailability |
| ZoneIdSlave1 |
string |
No |
The ID of the secondary availability zone. If the value of this parameter is the same as the value of the ZoneId parameter, the instance is deployed in a single availability zone. If the value is different, the instance is deployed in multiple availability zones. |
cn-hangzhou-c |
| ZoneIdSlave2 |
string |
No |
The ID of the logger availability zone. If the value of this parameter is the same as the value of the ZoneId parameter, the instance is deployed in a single availability zone. If the value is different, the instance is deployed in multiple availability zones. |
cn-hangzhou-d |
| DBInstanceStorageType |
string |
No |
The storage type of the instance. Valid values:
Note
Serverless instances support only PL1 ESSDs and general-purpose ESSDs. |
general_essd |
| RestoreTable |
string |
No |
Specifies whether to restore data to specific databases and tables. Set this parameter to 1. If you do not want to restore data to specific databases or tables, do not specify this parameter. |
1 |
| TableMeta |
string |
No |
The databases and tables that you want to restore. This parameter is required if you set the RestoreTable parameter to 1. The value is a JSON string in the following format:
|
[{"type":"db","name":"testdb1","newname":"testdb1_new","tables":[{"type":"table","name":"testdb1table1","newname":"testdb1table1_new"}]}] |
| DedicatedHostGroupId |
string |
No |
The dedicated cluster ID. |
dhg-7a9**** |
| BackupType |
string |
No |
The backup type. Valid values:
|
FullBackup |
| DeletionProtection |
boolean |
No |
Specifies whether to enable the release protection feature. Valid values:
|
true |
| IoAccelerationEnabled |
string |
No |
A parameter that is related to serverless instances. Specify this parameter only when you clone data to a serverless instance. Note
This parameter is supported only on the China site (aliyun.com). |
0 |
| BurstingEnabled |
boolean |
No |
This parameter is discontinued. You no longer need to specify this parameter. |
false |
| AutoPay |
boolean |
No |
Specifies whether to enable the Buffer Pool Extension (BPE) feature for a general-purpose ESSD. Valid values:
Note
For more information about BPE, see Buffer Pool Extension. |
true |
| CustomExtraInfo |
string |
No |
Specifies whether to enable the I/O burst feature for a general-purpose ESSD.
Note
For more information about the I/O burst feature, see What is a general-purpose ESSD?. |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The returned data. |
||
| DBInstanceId |
string |
The ID of the new instance. |
rm-uf6wjk5**** |
| OrderId |
string |
The ID of the associated order. |
100789370**** |
| RequestId |
string |
The request ID. |
1E43AAE0-BEE8-43DA-860D-EAF2**** |
Examples
Success response
JSON format
{
"DBInstanceId": "rm-uf6wjk5****",
"OrderId": "100789370****",
"RequestId": "1E43AAE0-BEE8-43DA-860D-EAF2****"
}
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 | 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. |
| 400 | InvalidTunnelId | Specified conn tunnel is not valid. | |
| 400 | ZoneId.NotMatchWithCategory | The number of available zones does not match the database engine or instance edition. Please reset it. | |
| 400 | UnsupportExtendDisk.NotSupport | Specified DB instance is unsupport extend disk. | Disk expansion is not supported on the specified instance. |
| 400 | Order.ComboInstanceNotAllowOperate | A package instance is not allowed to operate independently. | A package instance is not allowed to operate independently. |
| 400 | Price.PricingPlanResultNotFound | Pricing plan price result not found. | Pricing plan price result not found. |
| 400 | Order.NoRealNameAuthentication | You 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. | You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication. |
| 400 | InsufficientAvailableQuota | Your account quota limit is less than 0, please recharge before trying to purchase. | Your account available limit is less than 0, please recharge before trying to purchase. |
| 400 | CommodityServiceCalling.Exception | Failed to call commodity service. | Failed to call commodity service return. |
| 400 | RegionDissolvedEOM | Dear 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. | Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support. |
| 400 | Commodity.InvalidComponent | The module you purchased is not legal, please buy it again. | The module you purchased is not legal, please buy it again. |
| 400 | RegionEndTimeDissolvedAustralia | Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024. | Hello customer, this area has been abolished. |
| 400 | Price.CommoditySys | Commodity system call exception. | Commodity system call exception. |
| 400 | Pay.InsufficientBalance | Insufficient available balance. | Insufficient available balance. |
| 400 | Order.PeriodInvalid | There is a problem with the period you selected, please choose again. | There is a problem with the period you selected, please choose again. |
| 400 | pay.noCreditCard | Account not bound to credit card. | |
| 400 | Order.InstHasUnpaidOrder | There is an unpaid order for the service you have purchased. Please pay or void it before placing the order. | There is an unpaid order for the service you have purchased. Please pay or void it before placing the order. |
| 400 | noAvailablePaymentMethod | No payment method is specified for your account. We recommend that you add a payment method. | No payment method has been specified for your account. We recommend that you add a payment method. |
| 400 | BasicInfoUncompleted | Your information is incomplete. Complete your information before the operation. | Your basic information is not complete, please complete your basic information before operation. |
| 400 | Risk.RiskControlRejection | Your account is abnormal, please contact customer service for details. | Your account is abnormal, please contact customer service for details. |
| 400 | Api.NotSupport | Specified api is not supported. | The current interface does not support. |
| 400 | ContainForbiddenLabelError | There is a label that prohibits placing orders. Please contact your distributor for assistance. | You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor. |
| 400 | InvalidDBInstanceId.NotFound | The DBInstanceId provided does not exist in records. | The DBInstanceId provided does not exist. |
| 400 | InvalidParam | Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica. | The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica. |
| 400 | KmsApiError | User secret key invalid. | The user key is invalid. |
| 400 | System.SaleValidateFailed | Sales expression validation system error. | A system error occurs when the sales expression is verified. |
| 400 | Abs.InvalidAccount.NotFound | account is not found. | The account does not exist. |
| 400 | SqlExecuteFailedOrTimeout | sql command execution failed or timed out:%s. | SQL command execution failed or timed out |
| 400 | ColdData.EngineVersionNotSupport | The current instance engine version not support coldDataEnabled. | The current instance engine version not support coldDataEnabled. |
| 400 | ColdData.MinorVersionNotSupport | The current instance minor version not support coldDataEnabled. | The current instance minor version not support coldDataEnabled. |
| 400 | IncorrectTargetClasscode | The current instance type does not support this operation. | This operation is not supported by the instance type. |
| 400 | InvalidConnectionString.Duplicate | Specified connection string already exists in the RDS. | The link address name is duplicate. Please reset the connection string. |
| 400 | RequiredParam.NotFound | Required input param is not found. | |
| 400 | Parameters.Invalid | Parameter error, please check the parameters. | Parameter error, please check the parameters. |
| 400 | BackupPolicyNotSupport | Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy. | Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy. |
| 400 | InvalideStatus.Format | The instance status does not support this operation. | |
| 400 | InvalidReleasedKeepPolicy.Format | Specified Released Keep Policy is not valid. | Specified Released Keep Policy is not valid. |
| 400 | InvalidDBInstanceEngineType.Format | the DB instance engine type does not support this operation. | This operation is not supported for the database engine of the instance. |
| 400 | Pay.NoCreditCard | No credit cards. | No credit cards. |
| 400 | VpcNetworkTypeNotSupport | The vpc network type instance does not support this operation. | The vpc network type instance does not support this operation. |
| 400 | MirrorInsExists | Specified DB instance mirror ins already existed. | Specified DB instance mirror ins already existed. |
| 400 | UnsupportedClassCode | The specified DB instance class stops selling. | The specified DB instance class stops selling. |
| 400 | InvalidBackupSet | The specified database does not exist in the backup set. | The specified database does not exist in the backup set. |
| 400 | OrdTCommodityQueryError | Failed to query for product. | Failed to query product. |
| 400 | ProductInstanceReleased | The instance has been released. Please check before placing the order. | The instance has been released, please verify and place an order. |
| 400 | RegionEndTimeDissolvedIndia | The region is no longer supported. | The region is no longer supported. |
| 400 | StopService.Clone | The service has been discontinued and cloning operations on classic network instances are no longer permitted. | Because the classic network is offline and the service time has expired, you cannot clone an instance of the classic network type. |
| 400 | InvalidParam.UsedTime | The clone expiration date cannot exceed %s. | Because the classic network is offline, the usage time of the cloned classic network instance cannot exceed the limit time. |
| 400 | MinorVersionTag.NotFound | Minor version tags cannot be parsed by the instance. | |
| 400 | InvalidBakset.Invalid | Specified bakset is not valid. | |
| 400 | InvalidParamForXfs | Xfs instance must be single tenant standard instance. | Xfs instance must be single tenant standard instance. |
| 400 | AtLeastThreeVSwitchAvailableIp | The primary vswitch requires at least three available IP addresses. | The master switch requires at least 3 available IPs. |
| 400 | AtLeastTwoVSwitchAvailableIp | The primary vswitch requires at least two available IP addresses. | The master switch requires at least 2 available IPs. |
| 400 | DiskSize.NotEnough | The disk size is not enough to restore tables. | |
| 500 | ExternalFailure | The request processing has failed due to external service failure. | The request processing has failed due to external service failure. |
| 500 | RequestMetaDataFailed | The service request failed. Please try again later or contact service personnel. | The service request failed. Please try again later or contact service personnel. |
| 500 | InvokeProxyFailure | The request processing has failed due to service failure of rds api. | The request failed to be processed due to an RDS API failure. |
| 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. |
| 403 | CloudDiskEncryptionNotSupport | The encryption key is not allowed for general-purpose instance. | Universal instances do not support cloud disk encryption. |
| 403 | OrderStatus.UnPaid | The specified db instance has unpaid order. | The instance has an unpaid order. Please pay first and try again. |
| 403 | InvalidReduceDiskSize | The storage capacity after the scale-down must be larger than the used amount. | The scale-in target capacity cannot be less than the current storage space usage |
| 403 | CloudSSDNotSupport | Cloud ssd does not support this operation, please upgrade to essd. | |
| 403 | InvalidUserOperatorPermission | The user permission does not support this operation. | The user is not authorized to perform this operation. |
| 403 | InvalidVswitchId | Specified conn vswitch id is not valid. | |
| 403 | OperationDenied.ZoneResource | There is no available zone for inventory. | There is no available zone for inventory. |
| 403 | NotInFlowController | Sorry,no permission. | Sorry,no permission. |
| 403 | InvalidKmsKey | Kms key is disabled. | |
| 403 | InvalidInstanceLevel.Malformed | Current DB instance level does not support this operation. | The specified database instance type does not support this operation. |
| 403 | InvalidMeta.TooLarge | Meta information is too large. | The metadata information is too large. Check whether the number of instance tables exceeds 50000. |
| 404 | InvalidDBInstance.NotFound | The specified instance does not exist or is not supported. | The RDS instance cannot be found. Check the ID or name of the RDS instance. |
| 404 | InvalidClusterKms | The current instance does not authorized to access the Key Management Service. | The instance does not have permissions to access Key Management Service (KMS). |
| 404 | Request.NotFound | The requested resource is not available. | The requested resources are unavailable. |
| 404 | HostInfo.NotFound | The specified host info is not found. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.