Domain name for API request: tdmysql.intl.tencentcloudapi.com.
This API is used to create disaster recovery instances in batches.
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: CreateStandbyDBInstance. |
| 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. |
| PrimaryInstanceId | Yes | String | Primary instance id |
| 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 |
| Replications | Yes | Integer | Number of node replicas for storage, up to 5, must be an odd number |
| FullReplications | No | Integer | Number of replicas |
| InstanceName | No | String | Instance name. The required length is 1-60. It can contain Chinese characters, English case, digits, hyphens (-), and underscores (_). |
| TimeUnit | No | String | Time unit. y: year, m: month, d: day |
| TimeSpan | No | Integer | Commodity duration size |
| StorageNodeCpu | No | Integer | CPU cores of the storage node |
| StorageNodeMem | No | Integer | Storage node memory size |
| PayMode | No | String | Payment mode. 0 means pay-as-you-go/postpaid, 1 means prepaid. |
| Vport | No | Integer | Custom port |
| Zones.N | No | Array of String | Multi-AZ availability zone list |
| AutoVoucher | No | Boolean | Whether to use a coupon. |
| VoucherIds.N | No | Array of String | Coupon list |
| InstanceType | No | String | Instance Architecture Type. "hybrid" is supported since v19.0.0 |
| StorageType | No | String | Disk Type, CLOUD_HSSD enhanced SSD, CLOUD_TCS local SSD disk |
| ResourceTags.N | No | Array of ResourceTag | Tag key-value pair array |
| PrimaryInstanceRegion | No | String | Region of the primary instance |
| InstanceMode | No | String | Instance mode, normal: standard type; enhanced: enhanced |
| Password | No | String | dbaadmin password |
| SecurityGroupIds.N | No | Array of String | Bind the security group id list |
| Parameter Name | Type | Description |
|---|---|---|
| InstanceId | String | Instance ID |
| FlowId | Integer | Task ID. |
| 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: CreateStandbyDBInstance
<Common request parameters>
{
"PrimaryInstanceId": "tdsql3-c5eab757",
"Zone": "ap-chengdu-1",
"VpcId": "vpc-jksnni36",
"SubnetId": "subnet-dz7wfk4r",
"SpecCode": "1c2g",
"Disk": 20,
"StorageNodeNum": 3,
"Replications": 3,
"FullReplications": 3,
"StorageNodeCpu": 1,
"StorageNodeMem": 2,
"PayMode": "0",
"Zones": [
"ap-chengdu-1"
],
"InstanceType": "hybrid",
"StorageType": "CLOUD_HSSD",
"PrimaryInstanceRegion": "ap-chengdu",
"InstanceMode": "enhanced"
}{
"Response": {
"FlowId": 4295043361,
"InstanceId": "tdsql3-6e462513",
"RequestId": "329c5c1e-b337-4733-a46b-543c3ed59435"
}
}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 |
|---|---|
| FailedOperation.StandbyRelationCheckError | Disaster recovery relationship check error |
| FailedOperation.StandbyRelationParamError | Disaster recovery parameter error. |
| OperationDenied.InstanceOperationNotAllowedError | This operation is not supported for the instance currently. |
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