Domain name for API request: cynosdb.intl.tencentcloudapi.com.
This API is used to purchase a new cluster.
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: CreateIntegrateCluster. |
| Version | Yes | String | Common Params. The value used for this API: 2019-01-07. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo. |
| Zone | Yes | String | Availability zone |
| VpcId | Yes | String | VPC network ID |
| SubnetId | Yes | String | Subnet ID |
| DbVersion | Yes | String | Database version. Valid values: |
| ProjectId | No | Integer | Project ID |
| ClusterName | No | String | Cluster name. The length must be less than 64 characters. Each character can be an uppercase or lowercase letter, digit, or special symbol (-, _, .). |
| AdminPassword | No | String | Account (8-64 characters, containing any three of the following: uppercase and lowercase letters, digits, and symbols ~!@#$%^&*_-+=`|(){}[]:;'<>,.?/) |
| Port | No | Integer | Port. Default value: 3306. Value range: [0, 65535). |
| PayMode | No | Integer | Billing mode. Pay-as-you-go: 0; monthly subscription: 1. Default: pay-as-you-go. |
| Count | No | Integer | Number of clusters to purchase. Range of optional values: [1,3]. Default value: 1 |
| StorageLimit | No | Integer | Storage limit of a regular instance in GB When DbType is MYSQL and the storage billing mode is prepaid, this parameter cannot exceed the maximum storage specification corresponding to the cpu and memory. |
| TimeSpan | No | Integer | Annual and monthly subscription duration. |
| TimeUnit | No | String | Unit of the annual and monthly subscription duration. Valid values: s, d, m, y. |
| AutoRenewFlag | No | Integer | Whether Annual/Monthly Subscription is auto-renewed. Default value: 0. 0: default renewal method. 1: auto-renew. 2: no auto-renewal. |
| AutoVoucher | No | Integer | Whether to automatically select a voucher. 1: Yes; 0: No. Default is 0. |
| ResourceTags.N | No | Array of Tag | tag array information that needs to be bound for cluster creation |
| StoragePayMode | No | Integer | Cluster storage billing mode. Pay-as-you-go: 0. Monthly subscription: 1. Default: pay-as-you-go. When DbType is MYSQL and the cluster compute billing mode is pay-as-you-go (including when DbMode is SERVERLESS), the storage billing mode can only be pay-as-you-go.Rollback and clone do not support monthly subscription storage. |
| SecurityGroupIds.N | No | Array of String | Security group id array |
| AlarmPolicyIds.N | No | Array of String | Alarm policy Id array |
| ClusterParams.N | No | Array of ParamItem | Parameter array. It temporarily supports character_set_server (utf8 | latin1 | gbk | utf8mb4) and lower_case_table_names. 1: not case-sensitive; 0: case-sensitive. |
| DealMode | No | Integer | Transaction mode. 0: Place order and pay. 1: Place order |
| ParamTemplateId | No | Integer | Parameter template ID, which can be obtained by querying parameter template information through DescribeParamTemplates. |
| SlaveZone | No | String | Multi-az address |
| InstanceInitInfos.N | No | Array of IntegrateInstanceInfo | Instance initialization configuration information, primarily used for selecting different specification instances during cluster purchase. |
| GdnId | No | String | Global database unique ID |
| ProxyConfig | No | ProxyConfigInfo | Database proxy configuration |
| AutoArchive | No | String | Whether to automatically archive |
| AutoArchiveDelayHours | No | Integer | Archiving processing time after pausing |
| EncryptMethod | No | String | Encryption method (consists of the encryption algorithm and key pair version) |
| IntegrateCreateClusterConfig | No | IntegrateCreateClusterConfig | Integrated cluster configuration information |
| StorageVersion | No | String | Storage architecture type. Enumeration values: 1.0/2.0. Default value: 1.0 |
| Parameter Name | Type | Description |
|---|---|---|
| TranId | String | Frozen transaction ID |
| DealNames | Array of String | Order ID |
| ResourceIds | Array of String | Resource ID list (this field is no longer maintained. To obtain resource IDs, please use the dealNames field to query the DescribeResourcesByDealName API.) |
| ClusterIds | Array of String | Cluster ID list (this field is no longer maintained. To get the cluster ID, please use the dealNames field to query the DescribeResourcesByDealName API) |
| BigDealIds | Array of String | Large order number. |
| 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. |
Create Integrate Cluster
POST / HTTP/1.1
Host: cynosdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateIntegrateCluster
<Common request parameters>
{
"DbVersion": "8.0",
"InstanceInitInfos": [
{
"Cpu": 1,
"DeviceType": "common",
"InstanceCount": 1,
"InstanceType": "rw",
"Memory": 2
}
],
"IntegrateCreateClusterConfig": {
"BackupSaveDays": 7,
"BinlogSaveDays": 8,
"SemiSyncTimeout": 1000
},
"SubnetId": "subnet-3du8lpau",
"VpcId": "vpc-r2dqqiyv",
"Zone": "ap-guangzhou-4"
}{
"Response": {
"BigDealIds": [],
"ClusterIds": [],
"DealNames": [
"20250909448021542853581"
],
"RequestId": "081ec9cb-d476-4202-8943-966e1e552e3f",
"ResourceIds": [],
"TranId": "20250909448021542853591"
}
}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.CreateOrder | Failed to create and pay the order. |
| FailedOperation.InsufficientBalance | Insufficient account balance. |
| FailedOperation.OperationFailedError | Operation failed. Try again later. If the issue persists, contact customer service. |
| FailedOperation.QuerySpecBySpecCodeError | Specification information query failed. |
| FailedOperation.TradeCreateOrderError | Failed to create and pay for the order. Try again later. If the issue persists, contact customer service. |
| InternalError.DbOperationFailed | Query database failed. |
| InternalError.GetSubnetFailed | Failed to obtain the subnet. |
| InternalError.GetVpcFailed | Failed to get the VPC. |
| InternalError.InternalHttpServerError | http request execution error. |
| InternalError.UnknownError | Unknown internal error. |
| InvalidParameterValue.DBTypeNotFound | Unsupported instance type. |
| InvalidParameterValue.IllegalPassword | The password does not meet requirements. |
| InvalidParameterValue.InvalidDBVersion | Invalid instance version. |
| InvalidParameterValue.InvalidParameterValueError | Parameter value is invalid. |
| InvalidParameterValue.InvalidSpec | Invalid instance specification. |
| InvalidParameterValue.InvalidZoneIdError | Invalid AZ. |
| InvalidParameterValue.ProjectIdNotFound | ProjectId not found |
| InvalidParameterValue.RegionZoneUnavailable | The selected region and availability zone are unavailable. |
| InvalidParameterValue.SubnetNotFound | Subnet not found. |
| InvalidParameterValue.VpcNotFound | The selected VPC network is not found. |
| LimitExceeded.UserInstanceLimit | Number of user instances exceeds the limit. |
| OperationDenied.InsufficientBalanceError | Insufficient account balance. |
| OperationDenied.UserNotAuthenticatedError | User not verified with real-name authentication. Please proceed with real-name authentication before purchase. |
| UnauthorizedOperation.NotRealNameAccount | Non-verified users are prohibited from purchasing. |
| UnauthorizedOperation.PermissionDenied | CAM authentication failed. |
文档反馈