All Products
Search
Document Center

ApsaraDB RDS:CloneDBInstance

Last Updated:Mar 22, 2024

Restores the data of an original instance to a new instance. The new instance is called a cloned instance.

Operation description

Supported database engines

  • MySQL
  • PostgreSQL
  • SQL Server
  • MariaDB

References

Note Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
rds:CloneDBInstanceWRITE
  • DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
  • rds:ResourceTag
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringNo

The region ID. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
ZoneIdstringNo

The zone ID of the primary instance. You can call the DescribeRegions operation to query the zone ID.

Note Set this value to the zone ID of the original instance.
cn-hangzhou-b
DBInstanceClassstringNo

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
DBInstanceStorageintegerNo

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
DbNamesstringNo

The name of the database. If you specify more than one database, the value is in the following format: Original database name 1,Original database name 2.

test1,test2
PayTypestringYes

The billing method of the instance. Valid values:

Postpaid
InstanceNetworkTypestringNo

The network type of the new instance. Valid values:

  • VPC
  • Classic
Note By default, the new instance has the same network type as the original primary instance.
VPC
DBInstanceIdstringYes

The instance ID.

rm-uf6wjk5xxxxxxxxxx
BackupIdstringNo

The backup set ID.

You can call the DescribeBackups operation to query the backup set ID.

Note You must specify at least one of the BackupId or RestoreTime parameters.
902****
RestoreTimestringNo

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
VPCIdstringNo

The ID of the virtual private cloud (VPC).

Note Make sure that the VPC belongs to the required region.
vpc-uf6f7l4fg90xxxxxxxxxx
VSwitchIdstringNo

The ID of the vSwitch. The vSwitch must belong to the zone that is specified by ZoneId.

  • If you set InstanceNetworkType to VPC, you must also specify this parameter.
  • If you specify the ZoneSlaveId1 parameter, you must specify the IDs of two vSwitches for this parameter and separate the IDs with a comma (,).
vsw-uf6adz52c2pxxxxxxxxxx
PrivateIpAddressstringNo

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
UsedTimeintegerNo

The subscription duration of the new instance. Valid values:

  • If you set the Period parameter to Year, the value of the UsedTime parameter ranges from 1 to 3.
  • If you set the Period parameter to Month, the value of the UsedTime parameter ranges from 1 to 9.
Note If you set the PayType parameter to Prepaid, you must also specify this parameter.
1
PeriodstringNo

The unit that is used to calculate the billing cycle of the new instance. Valid values:

  • Year
  • Month
Note If you set the PayType parameter to Prepaid, you must also specify this parameter.
Year
CategorystringNo

The RDS edition of the instance. Valid values:

  • Basic: RDS Basic Edition.
  • HighAvailability: RDS High-availability Edition.
  • AlwaysOn: RDS Cluster Edition for ApsaraDB RDS for SQL Server.
  • cluster: RDS Cluster Edition for ApsaraDB RDS for MySQL.
  • Finance: RDS Enterprise Edition. This edition is available only on the China site (aliyun.com).

Serverless instances

  • serverless_basic: RDS Basic Edition. This edition is available only for serverless instances that run MySQL and PostgreSQL.
  • serverless_standard: RDS High-availability Edition for ApsaraDB RDS for MySQL
  • serverless_ha: RDS High-availability Edition for ApsaraDB RDS for SQL Server
Note You do not need to configure this parameter. The value of this parameter is the same as that of the original instance.
HighAvailability
ZoneIdSlave1stringNo

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
ZoneIdSlave2stringNo

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
DBInstanceStorageTypestringYes

The storage type of the instance. Valid values:

  • local_ssd: local SSDs
  • cloud_ssd: standard SSDs
  • cloud_essd: enhanced SSDs (ESSDs) of performance level 1 (PL1)
  • cloud_essd2: ESSDs of PL2
  • cloud_essd3: ESSD of PL3
Note Serverless instances support only ESSDs of PL 1. For a serverless instance, you must set this parameter to cloud_essd.
cloud_essd
RestoreTablestringNo

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
TableMetastringNo

The information about the database and table that you want to restore. The value is in the following 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"}]}]
DedicatedHostGroupIdstringNo

The ID of the dedicated cluster.

dhg-7a9xxxxxxxx
BackupTypestringNo

The type of backup that is used to restore the data of the original instance. Valid values:

  • FullBackup
  • IncrementalBackup
FullBackup
DeletionProtectionbooleanNo

Specifies whether to enable the release protection feature for the instance. Valid values:

  • true: enables the feature.
  • false (default): disables the feature.
true
AutoPausebooleanNo

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:

  • true: enables the feature.
  • false (default): disables the feature.
Note This parameter is supported only for serverless ApsaraDB RDS for MySQL instances.
true
MaxCapacitydoubleNo

The maximum number of RDS Capacity Units (RCUs). Valid values:

  • Serverless ApsaraDB RDS for MySQL instances: 1 to 8
  • Serverless ApsaraDB RDS for SQL Server instances: 2 to 8
  • Serverless ApsaraDB RDS for PostgreSQL instances: 1 to 12
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
MinCapacitydoubleNo

The minimum number of RCUs. Valid values:

  • Serverless ApsaraDB RDS for MySQL instances: 0.5 to 8.
  • Serverless ApsaraDB RDS for SQL Server instances: 2 to 8. Only integers are supported.
  • Serverless ApsaraDB RDS for PostgreSQL instances: 0.5 to 12.
Note The value of this parameter must be less than or equal to the value of MaxCapacity.
0.5
SwitchForcebooleanNo

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:

  • true: enables the feature.
  • false (default): disables the feature.
Note This parameter is supported only for serverless ApsaraDB RDS for MySQL instances.
false
IoAccelerationEnabledstringNo

A reserved parameter.

None
AutoPaybooleanNo

Specifies whether to automatically complete the payment. Valid values:

  1. true: automatically completes the payment. You must make sure that your account balance is sufficient.
  2. false: does not automatically complete the payment. An unpaid order is generated.
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

ParameterTypeDescriptionExample
object

The response parameters.

DBInstanceIdstring

The instance ID.

rm-uf6wjk5xxxxxxx
RequestIdstring

The request ID.

1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC
OrderIdstring

The ID of the order.

100789370****

Examples

Sample success responses

JSONformat

{
  "DBInstanceId": "rm-uf6wjk5xxxxxxx",
  "RequestId": "1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC",
  "OrderId": "100789370****"
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidAvZone.FormatSpecified AvZone is not valid.The value of the AvZone parameter is invalid. Check the value of this parameter.
400InvalidAvZone.NotSupportSpecified availableArea multiZone does not support in RDS.-
400CannotDecreaseEssdPerfLevelcannot 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.
400CannotDecreaseEssdPerfLevelinvalid cloud essd storage size.The storage capacity is invalid for ESSDs.
400InvalidIPAddress.ConflictIP address conflict.-
400CDDC.AvailableHostsNotEnoughInZoneNot enough available hosts are in the target zone.-
400InvalidInstanceLevel.DiskTypeSpecified instance level not support request disk typeThe current instance type does not support the specified storage 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 instanceThe 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.
400InvalidDBInstanceClass.OfflineThe 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.
400InvalidTunnelIdSpecified conn tunnel is not valid.-
403IncorrectMinorVersionCurrent engine minor version does not support operations.This operation is not supported for the current minor engine version.
403IncorrectCharacterTypeCurrent DB instance character type does not support this operation.This operation is not supported for the character type of the instance.
404InvalidDBInstance.NotFoundThe specified instance does not exist or is not supported.The RDS instance cannot be found. Check the ID or name of the RDS instance.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-01-04The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 403
    delete Error Codes: 404
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: IoAccelerationEnabled
    Added Input Parameters: BurstingEnabled
2023-11-21The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 403
    Added Error Codes: 404
2023-11-17The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change
    delete Error Codes: 403
2023-07-25The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change
    delete Error Codes: 403
2023-06-02The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 403
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: AutoPay
2022-06-23The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change
2022-02-10The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: DeletionProtection