CreateIntegrateCluster
Last updated:2025-11-13 20:51:33
CreateIntegrateCluster
Last updated: 2025-11-13 20:51:33
1. API Description
Domain name for API request: cynosdb.intl.tencentcloudapi.com.
This API is used to create a newly purchased cluster.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
2. Input Parameters
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 | Specifies the ID of the VPC network it belongs to. |
| SubnetId | Yes | String | Subnet ID. |
| DbVersion | Yes | String | Database version. valid values:. |
| ProjectId | No | Integer | Project ID |
| ClusterName | No | String | Cluster name, length less than 64 characters. each character value ranges from uppercase/lowercase letters, digits, special symbols ('-','_','.'). |
| AdminPassword | No | String | Account password (8-64 characters, a combination of uppercase and lowercase letters, digits and symbols ~!@#$%^&*_-+=`|(){}[]:;'<>,.?/ with any three types). |
| Port | No | Integer | Port, default 3306, in the range of [0, 65535). |
| PayMode | No | Integer | Billing mode. 0: pay-as-you-go; 1: monthly subscription. default is pay-as-you-go. |
| Count | No | Integer | Number of clusters to purchase. value range: [1,3]. default is 1. |
| StorageLimit | No | Integer | Maximum storage limit of a regular instance, in GB. When DbType is MYSQL and the storage billing mode is prepaid, this parameter should not exceed the maximum storage specification corresponding to cpu and memory. |
| TimeSpan | No | Integer | Specifies the annual and monthly subscription duration. |
| TimeUnit | No | String | Specifies the measurement unit for annual and monthly subscription duration. valid values: 's', 'd', 'm', 'y'. |
| AutoRenewFlag | No | Integer | Whether annual/monthly subscription is auto-renewed. default value is 0. 0 identifies the default renewal method, 1 means auto-renew, 2 indicates no auto-renewal. |
| AutoVoucher | No | Integer | Whether to automatically select a voucher. 1: yes; 0: no. default value: 0. |
| ResourceTags.N | No | Array of Tag | Specifies the tag array information that needs to be bound during cluster creation. |
| StoragePayMode | No | Integer | Specifies the cluster storage billing mode. 0: pay-as-you-go; 1: monthly subscription. default is pay-as-you-go. When DbType is MYSQL and the cluster billing mode for computing is postpaid (including DbMode as 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 | Specifies the Alarm policy Id array. |
| ClusterParams.N | No | Array of ParamItem | Parameter array, temporarily supports character_set_server (utf8|latin1|gbk|utf8mb4), lower_case_table_names. valid values: 1 (case-insensitive), 0 (case-sensitive). |
| DealMode | No | Integer | Transaction mode. valid values: 0 (place order and pay), 1 (place order). |
| ParamTemplateId | No | Integer | Parameter template ID. can be obtained through querying parameter template information DescribeParamTemplates. |
| SlaveZone | No | String | Multi-AZ address. |
| InstanceInitInfos.N | No | Array of IntegrateInstanceInfo | Initializes configuration information, mainly used to purchase clusters with different specification instances. |
| GdnId | No | String | Global database unique identifier. |
| ProxyConfig | No | ProxyConfigInfo | Database proxy configuration. |
| AutoArchive | No | String | Specifies whether to automatically archive. |
| AutoArchiveDelayHours | No | Integer | Processing time after pausing. |
| EncryptMethod | No | String | Encryption method (consists of encryption algorithm and key pair version). |
| IntegrateCreateClusterConfig | No | IntegrateCreateClusterConfig | Describes the cluster configuration information. |
| StorageVersion | No | String | Storage architecture type. valid values: 1.0/2.0. default value: 1.0. |
3. Output Parameters
| 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. please use the dealNames field and the query API DescribeResourcesByDealName to obtain resource ids). |
| ClusterIds | Array of String | Cluster ID list (this field is no longer maintained. please use the dealNames field to get cluster ids via the DescribeResourcesByDealName api.). |
| BigDealIds | Array of String | Large order number. 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. |
4. Example
Example1 Creating an Integrated Cluster
Create Integrate Cluster
Input Example
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"
}Output Example
{
"Response": {
"BigDealIds": [],
"ClusterIds": [],
"DealNames": [
"20250909448021542853581"
],
"RequestId": "081ec9cb-d476-4202-8943-966e1e552e3f",
"ResourceIds": [],
"TranId": "20250909448021542853591"
}
}5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
6. Error Code
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 the order and make a payment. |
| FailedOperation.InsufficientBalance | Insufficient account balance |
| FailedOperation.OperationFailedError | Operation failed. Try again later. If the problem persists, contact customer service. |
| FailedOperation.QuerySpecBySpecCodeError | Failed to query specifications. |
| FailedOperation.TradeCreateOrderError | Failed to create the order and make a payment. Please try again later. If the problem persists, please contact customer service. |
| InternalError.DbOperationFailed | Failed to query the database. |
| InternalError.GetSubnetFailed | Failed to get the subnet. |
| InternalError.GetVpcFailed | Failed to get the VPC. |
| InternalError.InternalHttpServerError | An exception occurred while executing the HTTP request. |
| InternalError.UnknownError | Unknown internal error. |
| InvalidParameterValue.DBTypeNotFound | Unsupported instance type. |
| InvalidParameterValue.IllegalPassword | The password does not meet the requirement. |
| InvalidParameterValue.InvalidDBVersion | Invalid instance version. |
| InvalidParameterValue.InvalidParameterValueError | Invalid parameter value. |
| InvalidParameterValue.InvalidSpec | Invalid instance specification. |
| InvalidParameterValue.InvalidZoneIdError | Invalid AZ |
| InvalidParameterValue.ProjectIdNotFound | The ProjectId was not found. |
| InvalidParameterValue.RegionZoneUnavailable | The selected region and AZ are unavailable. |
| InvalidParameterValue.SubnetNotFound | The selected subnet could not be found. |
| InvalidParameterValue.VpcNotFound | The selected VPC could not be found. |
| LimitExceeded.UserInstanceLimit | The number of instances exceeds the limit. |
| OperationDenied.InsufficientBalanceError | Insufficient account balance. |
| OperationDenied.UserNotAuthenticatedError | You need to verify your identity to make a purchase. |
| UnauthorizedOperation.NotRealNameAccount | Users who haven't completed identity verification can’t make purchases. |
| UnauthorizedOperation.PermissionDenied | CAM authentication failed. |
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No
Feedback