Domain name for API request: tdmysql.intl.tencentcloudapi.com.
This API is used to create clone instances.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: CreateCloneInstance. |
| Version | Yes | String | Common Params. The value used for this API: 2021-11-22. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| Zone | Yes | String | Creating an Instance Region |
| VpcId | Yes | String | Character type vpcid |
| SubnetId | Yes | String | Character type subnetid |
| SpecCode | Yes | String | Purchase specification |
| Disk | Yes | Integer | Node disk capacity (unit: GB) |
| StorageNodeNum | Yes | Integer | Number of storage nodes |
| InstanceId | Yes | String | Source instance id |
| InstanceName | No | String | Instance name. The required length is 1-60. It can contain Chinese characters, English case, digits, hyphens (-), and underscores (_). |
| ResourceTags.N | No | Array of ResourceTag | Tag key-value pair array |
| BackupName | No | String | Backup and rollback name |
| StorageNodeCpu | No | Integer | CPU cores of the storage node |
| StorageNodeMem | No | Integer | Storage node memory size |
| CreateVersion | No | String | Create version |
| Vport | No | Integer | Create port number |
| RecoverTime | No | String | Recovery time point |
| InstanceType | No | String | Instance Architecture Type, separate: decoupled architecture; hybrid: peer-to-peer architecture |
| StorageType | No | String | Disk Type, CLOUD_HSSD enhanced SSD, CLOUD_TCS local SSD disk |
| Zones.N | No | Array of String | Multi-AZ list, Zones[0] refers to the primary AZ |
| FullReplications | No | Integer | Number of replicas |
| InstanceMode | No | String | Instance mode, normal: standard type; enhanced: enhanced |
| Parameter Name | Type | Description |
|---|---|---|
| InstanceId | String | Clone instance ID Note: This field may return null, indicating that no valid values can be obtained. |
| FlowId | Integer | Task ID. Note: This field may return null, indicating that no valid values can be obtained. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: tdmysql.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateCloneInstance
<Common request parameters>
{
"Zone": "ap-chengdu-1",
"VpcId": "vpc-jksnni36",
"SubnetId": "subnet-dz7wfk4r",
"SpecCode": "1c2g",
"Disk": 20,
"StorageNodeNum": 3,
"InstanceId": "tdsql3-2a6b33ef",
"BackupName": "/tdsql3_ap_chengdu/251231015/tdsql3-2a6b33ef/automatic/physical/full-backup/2026-04-22/1776859363/tdstore-data",
"StorageNodeCpu": 1,
"StorageNodeMem": 2,
"CreateVersion": "21.2.5",
"InstanceType": "hybrid",
"StorageType": "CLOUD_HSSD",
"Zones": [
"ap-chengdu-1"
],
"InstanceMode": "enhanced"
}
{
"Response": {
"FlowId": 4295036956,
"InstanceId": "tdsql3-ba6b4cbc",
"RequestId": "f23a4c9f-39d1-489f-839f-bab199c2d37e"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| AuthFailure.CamAuthError | CAM authentication error. |
| AuthFailure.CheckCamAuthError | CAM authentication request parameter check failed. |
| AuthFailure.UnauthorizedOperation | CAM authentication failure. |
| DryRunOperation.AddTagDryrunError | Failed to bind the tag. |
| FailedOperation.CreateFlowError | Failed to create the task. |
| FailedOperation.DBCreateInstanceError | Failed to add instance data. |
| FailedOperation.DescribeFullBackupListError | Querying full backup list error. |
| InvalidParameter.CreateInstanceParamError | Parameter error in creating an instance. |
| InvalidParameterValue.CheckCloneInstanceDiskError | Query disk size error. |
| InvalidParameterValue.CheckDiskError | Disk size validation error. |
| InvalidParameterValue.CheckInstanceVersionError | Instance version validation error. |
| InvalidParameterValue.CheckNameError | Name verification failed. |
| InvalidParameterValue.CheckSpecError | Instance specification validation error. |
| InvalidParameterValue.CheckVpcError | VPC validation error. |
| InvalidParameterValue.NodeReplicasInvalidError | The number of instance replicas created does not meet specifications. |
| LimitExceeded.AddTagCountError | The number of bound tags exceeds the limit. |
| LimitExceeded.OutOfInstanceCntLimitError | The number of batch create instances exceeds the limit. |
| LimitExceeded.OutOfNodeReplicasLimitError | The number of replicas exceeds the limit. |
| LimitExceeded.OutOfSpecLimitError | The specification exceeds the limit. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback