CreateRabbitMQServerlessQueue

Last updated: 2025-10-30 22:05:25

CreateRabbitMQServerlessQueue

Last updated: 2025-10-30 22:05:25

1. API Description

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

This API is used to create an RabbitMQ queue.

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: CreateRabbitMQServerlessQueue.
Version	Yes	String	Common Params. The value used for this API: 2023-04-18.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
InstanceId	Yes	String	Instance ID
VirtualHost	Yes	String	VHost parameter.
QueueName	Yes	String	Queue name.
QueueType	No	String	Supports only classic.
Durable	No	Boolean	Durable flag. specifies that for the classic type, it must be passed in. for the quorum type, there is no need to pass it in and it is fixed as true.
AutoDelete	No	Boolean	Automatic cleanup. the classic type must be passed. the quorum type does not need to be passed and is fixed as false.
Remark	No	String	Remarks
MessageTTL	No	Integer	The MessageTTL parameter specifies settings dedicated to the classic type.
AutoExpire	No	Integer	The AutoExpire parameter, in milliseconds, indicates that the queue will be deleted if it is not used within a specified time.
MaxLength	No	Integer	MaxLength parameter. specifies the maximum number of entries the queue can hold. if the limit is exceeded, it will be handled according to the overview behavior.
MaxLengthBytes	No	Integer	The MaxLengthBytes parameter specifies the maximum length in bytes. if the value exceeds the limit, it will be handled according to the overview behavior.
DeliveryLimit	No	Integer	DeliveryLimit parameter. specifies the parameter dedicated to the quorum type.
OverflowBehaviour	No	String	OverflowBehaviour parameter specifies a value of drop-head, reject-publish, or reject-publish-dlx.
DeadLetterExchange	No	String	The DeadLetterExchange parameter specifies that expired or rejected messages can be routed to a designated dead letter exchange.
DeadLetterRoutingKey	No	String	The DeadLetterRoutingKey parameter specifies that it can only contain letters, digits, ".", "-", "@", and "_".
SingleActiveConsumer	No	Boolean	The SingleActiveConsumer parameter. if enabled, ensure that there is only one consumer consuming from the queue every time.
MaximumPriority	No	Integer	MaximumPriority parameter. specifies that it is dedicated for the classic type.
LazyMode	No	Boolean	LazyMode parameter. specifies that it is dedicated for the classic type.
MasterLocator	No	String	The MasterLocator parameter, dedicated to the classic type, specifies a value of min-masters, client-local, or random.
MaxInMemoryLength	No	Integer	MaxInMemoryLength parameter, dedicated for quorum type. specifies the maximum number of messages in memory for quorum queues.
MaxInMemoryBytes	No	Integer	The MaxInMemoryBytes parameter is dedicated to the quorum type. it specifies the maximum total message size in memory for quorum queues.
Node	No	String	Node parameter. optional. specifies the node where the specified creation queue is located.
DeadLetterStrategy	No	String	Consistency policy for dead-letter in arbitrating queues. specifies valid values: at-most-once, at-least-once. at-most-once is selected by default.
QueueLeaderLocator	No	String	Specifies the leader election strategy for the arbitration queue. valid values are client-local and balanced. the default value is client-local.
QuorumInitialGroupSize	No	Integer	Specifies the initial replica group size of the arbitration queue. the default value is 3.

3. Output Parameters

Parameter Name	Type	Description
QueueName	String	Queue 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 Create an RabbitMQ Queue

This example shows you how to create an RabbitMQ queue.

Input Example

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

{
    "InstanceId": "amqp-slmejnrgtz",
    "VirtualHost": "vhost1",
    "QueueName": "queue1",
    "QueueType": "vhost1",
    "Remark": "Test queuing"
}

Output Example

{
    "Response": {
        "QueueName": "queue1",
        "RequestId": "941a7f2b-26f7-413f-b91f-341678cd00f6"
    }
}

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
AuthFailure	CAM signature/authentication error.
DryRunOperation	DryRun operation means the request will be successful, but the DryRun parameter is passed.
FailedOperation	Operation failed.
InternalError	Internal error.
InvalidFilter	Invalid Filter
InvalidParameter	Parameter error.
InvalidParameterValue	Parameter value error.
LimitExceeded	The quota limit is exceeded.
MissingParameter	Parameters are missing
OperationDenied	Operation denied.
RegionError	Region error.
RequestLimitExceeded	Request limit exceeded.
ResourceInUse	The resource is occupied.
ResourceInsufficient	Insufficient resources.
ResourceNotFound	The resource does not exist.
ResourceUnavailable	Resources are unavailable.
ResourcesSoldOut	Resources are sold out.
UnauthorizedOperation	Unauthorized operation.
UnknownParameter	Unknown parameter error.
UnsupportedOperation	The operation is not supported.

Was this page helpful?

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

Yes

Feedback

tencent cloud