CreateRabbitMQVipInstance

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

CreateRabbitMQVipInstance

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

1. API Description

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

This API is used to create a RabbitMQ managed instance.

A maximum of 1 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: CreateRabbitMQVipInstance.
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.
ZoneIds.N	Yes	Array of Integer	AZ
VpcId	Yes	String	vpc ID, such as vpc-xxx. valid VpcId can be obtained by logging in to the virtual private cloud console (https://console.tencentcloud.com/vpc/vpc?rid=1) or via api call to DescribeVpcEx (https://www.tencentcloud.comom/document/api/215/1372?from_cn_redirect=1), retrieving the unVpcId field from the api response. if both VpcId and SubnetId are set to DEFAULT when creating an instance, the DEFAULT vpc network will be forcibly used.
SubnetId	Yes	String	The subnet ID of the vpc, such as subnet-xxx. valid subnet ids can be queried by logging in to the subnet console (https://console.tencentcloud.com/vpc/subnet?rid=1) or by calling the api DescribeSubnets and obtaining the unSubnetId field from the api response. if both SubnetId and VpcId are set to DEFAULT when creating an instance, the DEFAULT vpc network will be forcibly used.
ClusterName	Yes	String	Cluster name
NodeSpec	No	String	Node specification of the cluster. need to enter the corresponding specification flag. 2C8G:rabbit-vip-profession-2c8g 4C16G:rabbit-vip-profession-4c16g 8C32G:rabbit-vip-profession-8c32g 16C32G:rabbit-vip-basic-4 16C64G:rabbit-vip-profession-16c64g 2C4G:rabbit-vip-basic-5 4C8G:rabbit-vip-basic-1 8C16G (sold out): rabbit-vip-basic-2. Specifies the default value as 4C8G: rabbit-vip-basic-1.
NodeNum	No	Integer	Number of nodes, which is at least three for multi-AZ deployment. If this parameter is left empty, the value will be set to 1 for single-AZ deployment and 3 for multi-AZ deployment by default.
StorageSize	No	Integer	Storage capacity of a single node, which is 200 GB by default.
EnableCreateDefaultHaMirrorQueue	No	Boolean	Whether the default image queue is enabled. true means enabled, false means not enabled. defaults to false if not specified.
AutoRenewFlag	No	Boolean	Only applies to prepaid clusters (when PayMode parameter is 1). specifies whether the cluster is automatically renewed. true means auto-renewal is enabled. the default is true if not specified.
TimeSpan	No	Integer	Validity period, which is one month by default.
PayMode	No	Integer	Payment mode. 0: postpaid, (pay-as-you-go); 1: prepaid (monthly subscription). Monthly subscription is used by default.
ClusterVersion	No	String	Specifies the cluster edition. defaults to 3.8.30. valid values: 3.8.30, 3.11.8, 3.13.7.
IsIntl	No	Boolean	Whether the request is from the international website. Default value: false.
ResourceTags.N	No	Array of Tag	Resource tag list.
Bandwidth	No	Integer	Specifies the public bandwidth size in Mbps.
EnablePublicAccess	No	Boolean	Whether to enable public network access. If this parameter is not specified, the value is false by default.
EnableDeletionProtection	No	Boolean	Whether to enable cluster deletion protection. if this parameter is not specified, the value is false by default.

3. Output Parameters

Parameter Name	Type	Description
TranId	String	Order ID.
InstanceId	String	Instance 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 RabbitMQ Managed Instance

This example shows you how to create a managed version instance of RabbitMQ.

Input Example

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

{
    "ZoneIds": [
        190001
    ],
    "NodeSpec": "rabbit-vip-basic-2",
    "NodeNum": 1,
    "StorageSize": 100,
    "VpcId": "vpc-5ghsr4p9",
    "SubnetId": "subnet-67y9wil4",
    "ClusterName": "ApiCreate",
    "EnableCreateDefaultHaMirrorQueue": false
}

Output Example

{
    "Response": {
        "RequestId": "a8f28d5e-a7e2-4b0b-afa0-2fba09c077a0",
        "TranId": "20230110002025620411234",
        "InstanceId": "amqp-jero744g"
    }
}

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	Operation failed.
FailedOperation.CreateCluster	Failed to create the cluster.
InternalError	Internal error.
InvalidParameter	Incorrect parameter.

Was this page helpful?

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

Yes

Feedback

tencent cloud