CreateCluster

Last updated: 2025-11-25 10:54:23

CreateCluster

Last updated: 2025-11-25 10:54:23

1. API Description

Domain name for API request: tdmq.intl.tencentcloudapi.com.

This API is used to create a 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: CreateCluster.
Version	Yes	String	Common Params. The value used for this API: 2020-02-17.
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-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley.
ClusterName	Yes	String	Specifies the cluster name, which does not support chinese characters and special characters other than hyphens and underscores, with a length of no more than 64 characters.
BindClusterId	No	Integer	ID of your dedicated physical cluster. If it is not passed in, cluster resources will be created in a public cluster by default.
Remark	No	String	Remarks (up to 128 characters).
Tags.N	No	Array of Tag	Cluster tag list (deprecated).
PublicAccessEnabled	No	Boolean	Whether to enable public network access. If this parameter is left empty, the feature will be enabled by default

3. Output Parameters

Parameter Name	Type	Description
ClusterId	String	Cluster 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.

4. Example

Example1 Creating a Cluster

Input Example

https://tdmq.intl.tencentcloudapi.com/?Action=CreateCluster
&ClusterName=devName
&<Common request parameters>

Output Example

{
    "Response": {
        "ClusterId": "pulsar-5r59xd4vnx",
        "RequestId": "c1e66353-c87b-4a30-804d-94c6c2c8bac5"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

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
AuthFailure.UnauthorizedOperation	CAM authentication failed.
FailedOperation	Operation failed.
FailedOperation.CreateCluster	Failed to create the cluster.
InternalError	Internal error.
InternalError.SystemError	System error.
LimitExceeded.Clusters	The number of clusters under the instance exceeds the limit.
MissingParameter	Missing parameter.
MissingParameter.NeedMoreParams	A required parameter is missing.
ResourceInUse.Cluster	The cluster already exists.
ResourceUnavailable	The resource is unavailable.
ResourceUnavailable.CreateFailed	Assignment exception.
ResourceUnavailable.FundRequired	You must top up before proceeding.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud