DescribeRabbitMQServerlessQueueDetail

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

DescribeRabbitMQServerlessQueueDetail

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

1. API Description

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

This API is used to query RabbitMQ queue details.

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: DescribeRabbitMQServerlessQueueDetail.
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.

3. Output Parameters

Parameter Name	Type	Description
InstanceId	String	Instance ID
VirtualHost	String	Vhost parameter.
QueueName	String	Queue name.
QueueType	String	Specifies the queue type. the valid values are classic or quorum.
Consumers	Integer	Number of online consumers.
Durable	Boolean	Durable flag.
AutoDelete	Boolean	Automatic cleanup.
Remark	String	Remarks
MessageTTL	Integer	MessageTTL parameter, dedicated for classic type.
AutoExpire	Integer	AutoExpire parameter.
MaxLength	Integer	MaxLength parameter.
MaxLengthBytes	Integer	MaxLengthBytes parameter.
DeliveryLimit	Integer	DeliveryLimit parameter. specifies the parameter dedicated to the quorum type.
OverflowBehaviour	String	OverflowBehaviour parameter specifies a value of drop-head, reject-publish, or reject-publish-dlx.
DeadLetterExchange	String	DeadLetterExchange parameter.
DeadLetterRoutingKey	String	The DeadLetterRoutingKey parameter.
SingleActiveConsumer	Boolean	SingleActiveConsumer parameter.
MaximumPriority	Integer	MaximumPriority parameter. specifies that it is dedicated for the classic type.
LazyMode	Boolean	LazyMode parameter, dedicated for classic type.
MasterLocator	String	MasterLocator parameter, dedicated for classic type.
MaxInMemoryLength	Integer	MaxInMemoryLength parameter, dedicated for quorum type.
MaxInMemoryBytes	Integer	The MaxInMemoryBytes parameter is dedicated to the quorum type.
CreateTime	Integer	Create timestamp, in seconds.
Node	String	Node.
DeadLetterStrategy	String	Arbitration queue dead letter consistency policy.
QueueLeaderLocator	String	Leadership election policy for arbitration queue.
QuorumInitialGroupSize	Integer	Specifies the initial replica group size of the arbitration queue.
Exclusive	Boolean	Whether it is an exclusive queue.
Policy	String	The name of the policy that takes effect.
Arguments	String	Additional parameters key-value.
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 Query RabbitMQ Queue Detail

This example shows you how to inquiry RabbitMQ queue detail.

Input Example

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

{
    "InstanceId": "amqp-slmejnrgtz",
    "VirtualHost": "vhost1",
    "QueueName": "queue1"
}

Output Example

{
    "Response": {
        "RequestId": "e44774dc-597a-45d0-8a41-e5a13bae3878",
        "InstanceId": "amqp-slygmxjifs",
        "VirtualHost": "test-vhost",
        "QueueName": "queue-test",
        "QueueType": "classic",
        "Consumers": 0,
        "Durable": true,
        "AutoDelete": false,
        "Remark": "",
        "MessageTTL": 100000,
        "AutoExpire": 1,
        "MaxLength": 100,
        "MaxLengthBytes": 1204,
        "DeliveryLimit": 100,
        "OverflowBehaviour": "",
        "DeadLetterExchange": "",
        "DeadLetterRoutingKey": "",
        "SingleActiveConsumer": false,
        "MaximumPriority": 100,
        "LazyMode": false,
        "MasterLocator": "",
        "MaxInMemoryLength": 1024,
        "MaxInMemoryBytes": 1024,
        "CreateTime": 1739935376,
        "Node": "",
        "DeadLetterStrategy": "",
        "QueueLeaderLocator": "",
        "QuorumInitialGroupSize": 100,
        "Exclusive": false,
        "Policy": "",
        "Arguments": "{\"x-ordered\": false}"
    }
}

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