tencent cloud



Last updated: 2023-08-09 14:43:32

1. API Description

Domain name for API request: tdmq.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 No String Common Params. This parameter is not required for this API.
ClusterName Yes String Cluster name, which can contain up to 16 letters, digits, hyphens, and underscores.
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, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating cluster

Input Example

&<Common request parameters>

Output Example

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

5. Developer Resources


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

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
AuthFailure.UnauthorizedOperation CAM authentication failed.
FailedOperation Operation failed.
FailedOperation.CreateCluster Failed to create the cluster.
InternalError.SystemError System error.
LimitExceeded.Clusters The number of clusters under the instance exceeds the limit.
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.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support