Use CloneDBInstance to restore data to a new instance - ApsaraDB RDS - Alibaba Cloud - ApsaraDB RDS

Restores historical data to a new instance, also known as a clone instance.

Operation description

Supported engines

ApsaraDB RDS for MySQL
ApsaraDB RDS for PostgreSQL
ApsaraDB RDS for SQL Server
ApsaraDB RDS for MariaDB

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

rds:CloneDBInstance

create

DBInstance

acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

rds:ResourceTag

None

Request parameters

Parameter	Type	Required	Description	Example
ClientToken	string	No	The client token that is used to ensure the idempotence of the request and prevent duplicate submissions. You can use the client to generate the value, but you must ensure that the value is unique among different requests. The value can be up to 64 ASCII characters in length and cannot contain non-ASCII characters.	0c593ea1-3bea-11e9-b96b-88**********
RegionId	string	No	The region ID. You can call the DescribeRegions operation to view the region ID.	cn-hangzhou
ZoneId	string	No	The primary zone ID. You can call the DescribeRegions operation to view the zone ID. Note Default value: the zone ID of the source instance.	cn-hangzhou-b
DBInstanceClass	string	No	The instance type. For more information, see Instance types. Note Default value: the instance type of the primary instance.	mysql.n1.micro.1
DBInstanceStorage	integer	No	Instance storage capacity of the instance. Unit: GB. Instance storage capacity increases in increments of 5 GB. For more information, see Instance types. Note Default value: instance storage capacity of the primary instance.	1000
DBInstanceDescription	string	No	The instance name. It must be 2 to 255 characters in length. It must start with a letter or a Chinese character and can contain letters, digits, Chinese characters, underscores (_), and hyphens (-). Note It cannot start with http:// or https://.	testInstance
DbNames	string	No	The names of the databases. Format: `Original database name 1,Original database name 2`.	test1,test2
PayType	string	Yes	The billing method of the instance. Valid values: Postpaid: pay-as-you-go. Prepaid: subscription. Serverless: serverless. This value is not supported for ApsaraDB RDS for MariaDB instances. For more information, see Overview of serverless ApsaraDB RDS for MySQL instances, Overview of serverless ApsaraDB RDS for SQL Server instances, and Overview of serverless ApsaraDB RDS for PostgreSQL instances.	Postpaid
InstanceNetworkType	string	No	The network type of the instance. Valid values: VPC: Virtual Private Cloud (VPC). Classic: classic network. Note Default value: the network type of the primary 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 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 the instance. 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 the BackupId and RestoreTime parameters.	2011-06-11T16:00:00Z
VPCId	string	No	The VPC ID. Note Make sure that the VPC belongs to the region where the instance is deployed.	vpc-uf6f7l4fg90****
VSwitchId	string	No	The vSwitch ID. The zone (active zone) where the vSwitch is located must match the zone (active zone) ID specified in ZoneId. The network type InstanceNetworkType must be set to VPC. If you specify ZoneSlaveId1 (the secondary active zone ID), you must specify two vSwitch IDs and separate them with commas (,).	vsw-uf6adz52c2p****
PrivateIpAddress	string	No	The internal network IP address of the new instance. The IP address must be within the IP address range of the specified vSwitch. By default, the system automatically allocates an IP address based on the VPCId and VSwitchId parameters.	172.XX.XX.69
UsedTime	integer	No	The subscription duration. Valid values: Valid values when the Period parameter is set to Year: 1, 2, and 3. Valid values when the Period parameter is set to Month: 1 to 9. Note This parameter is required when the billing method is set to Prepaid.	1
Period	string	No	The subscription period of the subscription instance. Valid values: Year: yearly subscription. Month: monthly subscription. Note This parameter is required when the billing method is set to Prepaid. Valid values: Month : Monthly subscription. Year : Yearly subscription.	Year
Category	string	No	The instance edition. Valid values: Basic: Basic Edition. HighAvailability: high availability Edition (active). AlwaysOn: Cluster Edition (SQL Server). cluster: Cluster Edition (MySQL). Finance: Finance Edition (supported only on the China site). Serverless instances serverless_basic: Serverless Basic Edition (applicable only to MySQL and PostgreSQL). serverless_standard: MySQL Serverless high availability Edition (active). serverless_ha: SQL Server Serverless high availability Edition (active). Note You do not need to specify this parameter. The cloned instance inherits the edition of the source instance.	HighAvailability
ZoneIdSlave1	string	No	The secondary zone (active zone) ID. If this parameter is set to the same value as the ZoneId parameter, the instance uses a single-zone (active zone) deployment. If this parameter is set to a different value from the ZoneId parameter, the instance uses a multi-zone (active zone) deployment.	cn-hangzhou-c
ZoneIdSlave2	string	No	The logger zone (active zone) ID. If this parameter is set to the same value as the ZoneId parameter, the instance uses a single-zone (active zone) deployment. If this parameter is set to a different value from the ZoneId parameter, the instance uses a multi-zone (active zone) deployment.	cn-hangzhou-d
DBInstanceStorageType	string	No	The instance storage type. Valid values: general_essd: Premium ESSD (recommended). local_ssd: premium local disk. cloud_ssd: standard SSD. cloud_essd: PL1 ESSD. cloud_essd2: PL2 ESSD. cloud_essd3: PL3 ESSD. Note Serverless instances support only PL1 ESSD and Premium ESSD.	general_essd
RestoreTable	string	No	Specifies whether to restore individual databases and tables. A value of true specifies that individual databases and tables are restored. If you do not want to restore individual databases and tables, leave this parameter empty.	true
TableMeta	string	No	The information about the databases and tables that you want to restore. This parameter is required when you restore individual databases and tables. Format: [{"type":"db","name":"Name of database 1","newname":"New name of database 1","tables":[{"type":"table","name":"Name of table 1 in database 1","newname":"New name of table 1"},{"type":"table","name":"Name of table 2 in database 1","newname":"New name of table 2"}]},{"type":"db","name":"Name of database 2","newname":"New name of database 2","tables":[{"type":"table","name":"Name of table 1 in database 2","newname":"New name of table 1"},{"type":"table","name":"Name of table 2 in database 2","newname":"New name of table 2"}]}]	[{"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-7a9****
BackupType	string	No	The backup type. Valid values: FullBackup: full backup. IncrementalBackup: incremental backup.	FullBackup
DeletionProtection	boolean	No	Specifies whether to enable the release protection feature. Valid values: true: enables the feature. false (default): disables the feature.	true
IoAccelerationEnabled	string	No	The serverless configurations. This parameter is required only when you clone data to a serverless instance. Note This parameter is supported only on the China site.	0
BurstingEnabled	boolean	No	[Deprecated] This parameter is deprecated and does not need to be configured.	0
AutoPay	boolean	No	Specifies whether to enable the Buffer Pool Extension (BPE) feature for Premium ESSD cloud disks. Valid values: 1: enables the feature. 0: disables the feature. Note For more information about the BPE feature, see Buffer Pool Extension (BPE).	0
CustomExtraInfo	string	No	Specifies whether to enable the I/O performance burst feature for Premium ESSD cloud disks. Valid values: true: enables the feature. false: shutdown. Note For more information about the I/O performance burst feature, see What is a premium performance disk.	false
Tag	array<object>	No	Specifies whether to enable automatic payment. Valid values: true: enables automatic payment. Make sure that your account balance is sufficient. false: generates an order but does not deduct fees. Note Default value: true. If your payment method has an insufficient balance, you can set the AutoPay parameter to false. In this case, an unpaid order is generated, and you can log on to the ApsaraDB RDS console to complete the payment.	true
	object	No	The details of the tags.
Key	string	No	The tag key. You can specify this parameter to add a tag to the instance. If the specified tag key already exists, the tag key is directly added to the instance. You can call the ListTagResources operation to query existing tags. If the specified tag key does not exist, the tag key is created and then added to the instance. Empty strings are not allowed. This parameter must be used together with the Tag.Value parameter and cannot be used alone.	testkey1
Value	string	No	The tag value that corresponds to the tag key. You can specify this parameter to add a tag to the instance. If the specified tag value already exists for the corresponding tag key, the tag value is directly added to the instance. You can call the ListTagResources operation to query existing tags. If the specified tag value does not exist for the corresponding tag key, the tag value is created and then added to the instance. This parameter must be used together with the Tag.Key parameter and cannot be used alone.	testvalue1

Response elements

Element	Type	Description	Example
	object	The response parameters.
DBInstanceId	string	The instance ID.	rm-uf6wjk5****
OrderId	string	The order ID.	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.	The specified availableArea multiZone is not supported in ApsaraDB 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.	An IP address conflict occurred.
400	CDDC.AvailableHostsNotEnoughInZone	Not enough available hosts are in the target zone.	The destination zone does not have sufficient host resources. Create a host in the 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	Local disks cannot be cloned to cloud disks.
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.	The specified connection channel is invalid.
400	ZoneId.NotMatchWithCategory	The number of available zones does not match the database engine or instance edition. Please reset it.	The number of zones does not match the database engine or instance edition. Reconfigure the settings.
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.	Your account is not linked to a 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.	The required parameters are not provided.
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.	The current 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.	This operation is not supported for the specified backup set.
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.	The remaining disk space is insufficient.
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.	Standard SSDs do not support this operation. Upgrade to ESSDs.
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.	The specified VSwitchId is invalid or empty.
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.	The 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.	The specified host information does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.

ApsaraDB RDS:CloneDBInstance