CreateProCluster

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

CreateProCluster

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

1. API Description

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

This api is used to create a professional cluster with prepayment via api calls.

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: CreateProCluster.
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.
ZoneIds.N	Yes	Array of Integer	Specifies multi-az deployment with three azs, for example [200002,200003,200004]. Single-AZ deployment selects an availability zone. example: [200002].
ProductName	Yes	String	Cluster specification code. Refers to professional cluster specifications (https://www.tencentcloud.comom/document/product/1179/83705?from_cn_redirect=1).
StorageSize	Yes	Integer	Specifies the storage specification. Refers to professional cluster specifications (https://www.tencentcloud.comom/document/product/1179/83705?from_cn_redirect=1).
AutoRenewFlag	Yes	Integer	`1`: true. enables automatic monthly renewal. false. disables automatic monthly renewal.
TimeSpan	Yes	Integer	Purchase duration. value range: 1–50.
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.
AutoVoucher	Yes	Integer	Whether to automatically select voucher. valid values: 1 (yes), 0 (no). default is 0.
Vpc	No	VpcInfo	Specifies the vpc network tag.
Tags.N	No	Array of Tag	Tag list of the cluster (abandoned).

3. Output Parameters

Parameter Name	Type	Description
DealName	String	Specifies the sub-order number.
BigDealId	String	Order ID
ClusterId	String	Cluster ID
ClusterName	String	Cluster name.
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 Professional Cluster

This example shows you how to create a professional cluster using only api invocation.

Input Example

POST / HTTP/1.1
Host: tdmq.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateProCluster
<Common request parameters>

{
    "ZoneIds": [
        200002,
        200003,
        200004
    ],
    "ProductName": "devTest",
    "StorageSize": 0,
    "AutoRenewFlag": 0,
    "TimeSpan": 0,
    "Vpc": {
        "VpcId": "vpc-8jiausye",
        "SubnetId": "subnet-1iuyhzke"
    },
    "Tags": [
        {
            "TagKey": "devTag",
            "TagValue": "dev"
        }
    ],
    "ClusterName": "devTest",
    "AutoVoucher": 0
}

Output Example

{
    "Response": {
        "DealName": "202403206137826783502561 ",
        "BigDealId": "202403206137826783502561 ",
        "ClusterId": "pulsar-x4r939zkwmm2",
        "ClusterName": "devTest",
        "RequestId": "0799dd77-707b-40d7-a4b5-4140b11f6c97"
    }
}

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
FailedOperation.CloudService	Third-Party cloud service exception. try again later.
FailedOperation.CreateProClusterRegionNotExist	Region not supported for sdk creation.
FailedOperation.GenerateDealsAndPayError	Parameters are abnormal. ordering failed.
FailedOperation.OperateLater	Task in progress. please try again later.
FailedOperation.ProductNotExist	Product information not found.
InvalidParameter.Vpc	Invalid vpc information or subnet info.
MissingParameter.Tag	Tag information is missing.

Was this page helpful?

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

Yes

Feedback

tencent cloud