ApsaraDB RDS:CloneDBInstance

A client-generated token that ensures request idempotence. This prevents duplicate requests. The token must be unique across requests, contain only ASCII characters, and not exceed 64 characters in length.

The ID of the region. You can call the DescribeRegions operation to query region IDs.

The ID of the availability zone for the new instance. You can call the DescribeRegions operation to query availability zone IDs.

The instance type of the new instance. For more information, see Instance types.

The storage capacity of the instance. Unit: GB. The value must be in 5 GB increments. For more information, see Instance types.

The description of the new instance. The description must be 2 to 255 characters long. It must start with a letter or a Chinese character, and can contain letters, digits, Chinese characters, underscores (_), and hyphens (-).

The databases to clone from the source instance, specified as a comma-separated list.

The billing method. Valid values:

• Postpaid: pay-as-you-go

• Prepaid: subscription

• Serverless: Serverless billing. This value is not supported for MariaDB instances. For more information, see Introduction to MySQL Serverless instances, Introduction to SQL Server Serverless instances, and Introduction to PostgreSQL Serverless instances.

The network type of the instance. Valid values:

• VPC: VPC

• Classic: classic network

The ID of the source instance that you want to clone.

The ID of the backup.

You can call the DescribeBackups operation to query a list of backups.

The point in time to which you want to restore data. The time must be within the backup retention period. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format (UTC).

The VPC ID.

The vSwitch ID. The vSwitch must be in the availability zone specified by the ZoneId parameter.

• This parameter is required if you set InstanceNetworkType to VPC.

• If you specify ZoneIdSlave1 (the availability zone for the secondary node), you must specify two vSwitch IDs, separated by a comma.

The private IP address of the new instance. The IP address must be within the IP address range of the specified vSwitch. If you do not specify this parameter, the system automatically assigns a private IP address based on the specified VPCId and VSwitchId.

The subscription duration. Valid values:

• If you set Period to Year, the value of UsedTime ranges from 1 to 3.

• If you set Period to Month, the value of UsedTime ranges from 1 to 9.

The unit of the subscription duration specified by the UsedTime parameter. Valid values:

• Year

• Month

The instance edition. Valid values:

• Basic: Basic

• HighAvailability: High-availability

• AlwaysOn: Cluster (SQL Server)

• cluster: Cluster (MySQL)

• Finance: Enterprise (This edition is available only in the Chinese mainland.)

Serverless instances

• serverless_basic: Serverless Basic (available only for MySQL and PostgreSQL)

• serverless_standard: Serverless High-availability for MySQL

• serverless_ha: Serverless High-availability for SQL Server

The ID of the availability zone for the secondary node. If you set this parameter to the same value as the ZoneId parameter, the instance uses a single-AZ deployment. If you set this parameter to a different value, the instance uses a multi-AZ deployment.

The ID of the availability zone for the logger node. If this parameter is set to the same value as the ZoneId parameter, the instance uses a single-AZ deployment. If this parameter is set to a different value, the instance uses a multi-AZ deployment.

The storage type of the instance. Valid values:

• general_essd: Enhanced SSD (ESSD) (recommended)

• local_ssd: local SSD

• cloud_ssd: SSD cloud disk

• cloud_essd: ESSD PL1 cloud disk

• cloud_essd2: ESSD PL2 cloud disk

• cloud_essd3: ESSD PL3 cloud disk

Set this parameter to 1 to restore only specific databases or tables.

The databases and tables to restore, specified as a JSON string. This parameter is required if RestoreTable is set to 1. The value must be in the following format: [{"type":"db","name":"<Source database 1>","newname":"<New database 1>","tables":[{"type":"table","name":"<Source table 1 in database 1>","newname":"<New table 1>"},{"type":"table","name":"<Source table 2 in database 1>","newname":"<New table 2>"}]},{"type":"db","name":"<Source database 2>","newname":"<New database 2>","tables":[{"type":"table","name":"<Source table 1 in database 2>","newname":"<New table 1>"},{"type":"table","name":"<Source table 2 in database 2>","newname":"<New table 2>"}]}]

The ID of the dedicated cluster.

The backup type. Valid values:

• FullBackup: full backup

• IncrementalBackup: incremental backup

Specifies whether to enable deletion protection. Valid values:

• true: Enables deletion protection.

• false (default): Disables deletion protection.

This parameter applies only when you clone an instance to a Serverless instance.

This parameter is deprecated. Do not use it.

Specifies whether to enable automatic payment. Valid values:

• true: Enables automatic payment.

• false (default): Disables automatic payment.

Specifies whether to enable I/O burst for an Enhanced SSD (ESSD).

• true: Enable I/O burst.

• false: Disable I/O burst.