CreateRocketMQVipInstance

Last updated: 2025-11-25 10:53:02

CreateRocketMQVipInstance

Last updated: 2025-11-25 10:53:02

1. API Description

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

This API is used to create a RocketMQ Exclusive Edition instance.

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: CreateRocketMQVipInstance.
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.
Name	Yes	String	Instance name
Spec	Yes	String	Cluster specification. Supported specifications: 1. General: rocket-vip-basic-0; 2. Basic: rocket-vip-basic-1; 3. Standard: rocket-vip-basic-2; 4. Advanced I: rocket-vip-basic-3; 5. Advanced II: rocket-vip-basic-4.
NodeCount	Yes	Integer	Number of nodes. Value range: 2–20.
StorageSize	Yes	Integer	Single-node storage space, in GB. The minimum space is 200 GB.
ZoneIds.N	Yes	Array of String	The zone ID list for node deployment. For example, the ID of Guangzhou Zone 1 is 100001. For details, see the official website of the cloud platform.
VpcInfo	Yes	VpcInfo	Describes the VPC information.
TimeSpan	Yes	Integer	Purchase duration, in months.
SupportsMigrateToCloud	No	Boolean	Whether it is used for cloud migration. The default value is false.
EnablePublic	No	Boolean	Specifies whether public network access is enabled.
Bandwidth	No	Integer	Public network bandwidth, a required field when the public network is enabled.
IpRules.N	No	Array of PublicAccessRule	Public network allowlist.
Tags.N	No	Array of Tag	Tag.

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 Purchasing a RocketMQ Dedicated Instance

This example shows you how to purchase a RocketMQ dedicated instance.

Input Example

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

{
    "Name": "test_instance",
    "Spec": "rocket-vip-basic-1",
    "NodeCount": 2,
    "StorageSize": 200,
    "ZoneIds": [
        "100001",
        "100002"
    ],
    "VpcInfo": {
        "VpcId": "vpc-9dlrd5h1",
        "SubnetId": "subnet-jadmas"
    },
    "TimeSpan": 1
}

Output Example

{
    "Response": {
        "ClusterId": "rocketmq-7drjznvjqzee",
        "RequestId": "23ca1a58-0388-4d2d-8465-653a53addda7"
    }
}

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.CallTrade	An exception occurred while calling the transaction service.

Was this page helpful?

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

Yes

Feedback

tencent cloud