Message Queue for RabbitMQ
Message Queue for RabbitMQ
Document
- Documentation
Message Queue for RabbitMQAPI referenceV2（2022-01-01）Instance lifecycle managementCreate Instance - Create instance
Copy page
Download PDFInstance lifecycle management
Create Instance - Create instance
Copy pageDownload PDFCreate Instance - Create instance
Call the Create Instance API to create a Message Queue for RabbitMQ instance.
Instructions
An instance is a virtual machine resource of the Message Queue for RabbitMQ service.
tip
- If creating a RabbitMQ instance for the first time, you must complete cross-service access authorization first. We recommend that you use the VolcanoEngine main account to perform this. For detailed specifications, refer to Cross-service access authorization.
- If you need to access the message queue for RabbitMQ instance through a private network, first create an ECS cloud server, private network, and subnet in the same region. After creating instance, you can not change its private network and subnet.
- If you need to access the Message Queue Kafka instance via a public network, first apply for an EIP in the same region. For detailed operation steps, refer to apply for Elastic IP.
- By default, you can create 5 RabbitMQ instances in each region. To increase quotas, apply in the Quota Center to raise the maximum number of instances per region (InstanceNum), up to 10.
Note
Request frequency: This API limits requests to 100 times per second; the per-user request frequency limit is 20 times per second.
Debug
API Explorer
You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.
Request parameters
Only the unique request parameters of this interface and some common parameters are listed below. For more information, see common parameters.
Action string required Example value: CreateInstance
Actions to perform, values: CreateInstance.
Version string required Example value: 2022-01-01
API version, value: 2022-01-01.
ZoneId string required Example value: cn-beijing-a
Availability zone of the instance.
- Message Queue for RabbitMQ instances support cross-availability zone deployment. When checking which specifications are available in designated zones, you can specify multiple availability zones. Separate multiple availability zone IDs with commas (,).
- You can call the DescribeAvailabilityZones API to query the list of availability zones currently served.
UserName string required Example value: Test1
User name. The following requirements must be met:
- Can only include English letters, numbers, hyphens (-), or underscores (_).
- Length should be 3 to 64 characters.
ComputeSpec string required Example: rabbitmq.n3.x2.medium
Instance specifications.
The list of computing specifications provided by Message Queue for RabbitMQ instances. See product specifications for details.
Version string required Example: 3.8.18
Supported RabbitMQ versions. Currently supported versions include:
- 3.8.18: RabbitMQ version 3.8.18.
- 3.12: RabbitMQ version 3.12.
UserPassword string required Example: Test@123456
User password. The following requirements must be met:
- Length between 8 and 32 characters.
- Composed of any three types among uppercase letters, lowercase letters, numbers, and special characters.
- Supported special characters include !@#$%^&*()_+-=.
StorageSpace integer required Example value: 1000
Instance storage space.
Unit is GiB and must be specified in multiples of 100. The value range and default depend on the currently specified compute specification.
InstanceDescription string Optional Example: instance for test
Brief description of the RabbitMQ instance. The length of characters ranges from 1 to 128.
VpcId string required Example value: vpc-13fo9gkz6j6683n6q****
The private network (VPC) ID where the instance is located.
tip
- After the instance is created, you cannot modify its private network or subnet. Proceed carefully when creating the instance.
- You can call the DescribeVpcs interface of the Virtual Private Cloud (VPC) to query the list of available VPCs and subnets.
ChargeInfo object required Example value: /
Billing information such as the billing method of the RabbitMQ instance.
ChargeType string required Example: PostPaid
Billing method of the instance. Supported types include:
- PostPaid: pay-as-you-go
- PrePaid: subscription
tip
When PrePaid is specified, you must also specify AutoRenew, PeriodUnit, and Period parameters.
AutoRenew boolean Optional Example value: false
whether to auto-renew after the subscription instance expires.
- true: Auto-renewal enabled.
- false: do not auto-renew. manual renewal is required after expiration. Otherwise, the instance will be shut down.
tip
Only Subscription instances need to be specified, i.e. when ChargeType is set to PrePaid, it is required.
PeriodUnit string Optional Example: Month
Subscription instance lifecycle unit, supports purchasing in months or years. Supports the following settings:
- Month: Monthly subscription
- Year: subscription
tip
Only required for subscription instances. Required when ChargeType is set to PrePaid.
Period integer Optional Example value: 1
Subscription duration for subscription-type instances.
- When PeriodUnit is set to Month, the value range is 1–9.
- When PeriodUnit is set to Year, the value range is 1–3.
tip
Only Subscription instances need to be specified, i.e. when ChargeType is set to PrePaid, it is required.
SubnetId string required Example: subnet-min6uy01kuf45sk****
VPC subnet ID where the instance is located.
tip
- After the instance is created, you cannot modify its private network or subnet. Proceed carefully when creating the instance.
- You can call the DescribeVpcs interface of the Virtual Private Cloud (VPC) to query the list of available VPCs and subnets.
EipId string Optional Example: eip-mjhulvqza6805smt****
The ID of the EIP.
tip
- Specifying EipId enables public network access for the instance.
- The EIP provides independent public IP resources, including the public IP address and outbound bandwidth service. When this parameter is specified to enable public network access, the public address will bind to your Elastic IP (EIP), and fees are charged by the EIP.
InstanceName string Optional Example: Name123
Name of the RabbitMQ instance. The following requirements must be met:
- Can only contain Chinese characters, letters, numbers, underscores (_), or hyphens (-).
- Cannot start with a number or hyphen (-).
- The length of characters ranges from 1 to 128.
tip
If no name is specified when creating the instance, the instance ID will be used as the instance name by default.
ClientToken string required Example value: 123e4567-e89b-12d3-a456-42665544****
Identifier ensuring idempotency of client requests.
This identifier is a 1 to 64 character ASCII string, case-sensitive, generated by the client. It must be unique across different requests.
Tags object[] Optional Example: /
Cloud resource tags. Instances can be categorized using tags for easier searching and resource aggregation. For detailed information, refer to Tag management.
Key string required Example value: owner
Tag key.
Value string Optional Example value: zhangsan
The tag value.
ProjectName string Optional Example: newproject
The IAM project to which the currently created RabbitMQ instance belongs.
tip
If no IAM project is specified, message queue for RabbitMQ will add the new instance to the IAM project named Default.
Response parameters
Only the unique response parameters of this API are listed below. For more details, see response structure.
InstanceId string Example value: rbtmq-5b293870****
RabbitMQ instance ID.
OrderId string Example value: order-712089661643355****
Order ID.
Request example
POST /?Action=CreateInstance&Version=2022-01-01 HTTP/1.1
Host: rabbitmq.cn-beijing.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20260106T081321Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20260106/cn-beijing/RabbitMQ/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f
{
"ZoneId": "cn-beijing-a",
"UserName": "Test1",
"ComputeSpec": "rabbitmq.n3.x2.medium",
"Version": "3.8.18",
"UserPassword": "Test@123456",
"StorageSpace": 1000,
"VpcId": "vpc-13fo9gkz6j6683n6q****",
"ChargeInfo": {
"ChargeType": "PostPaid"
},
"SubnetId": "subnet-min6uy01kuf45sk****",
"ClientToken": "123e4567-e89b-12d3-a456-42665544****"
}
Response example
{
"ResponseMetadata": {
"RequestId": "2026010616132822821908701442****",
"Action": "CreateInstance",
"Version": "2022-01-01",
"Service": "RabbitMQ",
"Region": "cn-beijing"
},
"Result": {
"InstanceId": "rbtmq-5b293870****",
"OrderId": "order-712089661643355****"
}
}
Error code
Error codesThe following table lists error codes related to this interface and business logic. Refer to the Public error codes section for common error codes.
Last updated: 2026.02.06 14:27:44
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
