tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateRabbitMQVipInstance

Last updated: 2023-04-18 14:53:03

1. API Description

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

This API is used to create a TDMQ for RabbitMQ exclusive 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 No String Common Params. This parameter is not required for this API.
ZoneIds.N Yes Array of Integer AZ
VpcId Yes String VPC ID
SubnetId Yes String VPC subnet ID
ClusterName Yes String Cluster name
NodeSpec No String Node specification (rabbit-vip-basic-1: Basic; rabbit-vip-basic-2: Standard; rabbit-vip-basic-3: Advanced I; rabbit-vip-basic-4: Advanced II). If this parameter is left empty, the default value is 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 to enable mirrored queue. Default value: false.
AutoRenewFlag No Boolean Whether to enable auto-renewal. Default value: true.
TimeSpan No Integer Validity period, which is one month by default.

3. Output Parameters

Parameter Name Type Description
TranId String Order ID
Note: This field may return null, indicating that no valid values can be obtained.
InstanceId String Instance ID
Note: This field may return null, indicating that no valid values can be obtained.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating a TDMQ for RabbitMQ exclusive instance

This example shows you how to create a TDMQ for RabbitMQ exclusive instance.

Input Example

POST / HTTP/1.1
Host: tdmq.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-xxx",
    "SubnetId": "subnet-xxx",
    "ClusterName": "ApiCreate",
    "EnableCreateDefaultHaMirrorQueue": false
}

Output Example

{
    "Response": {
        "RequestId": "sadasfdsfs",
        "TranId": "20230110002025620411234",
        "InstanceId": "amqp-aegnagjg"
    }
}

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

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.
InternalError Internal error.
InvalidParameter Incorrect parameter.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy