tencent cloud

DescribeRabbitMQQueueDetail
Last updated: 2025-11-25 10:53:16
DescribeRabbitMQQueueDetail
Last updated: 2025-11-25 10:53:16

1. API Description

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

This API is used to query the details of RabbitMQ queues.

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: DescribeRabbitMQQueueDetail.
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.
InstanceId Yes String Instance ID, such as amqp-xxxxxxxx. valid InstanceId can be queried by logging in to the TDMQ RabbitMQ console (https://console.tencentcloud.com/trabbitmq/cluster?rid=1).
VirtualHost Yes String VirtualHost name, such as testvhost. effective VirtualHost names can be queried by logging in to the TDMQ RabbitMQ console (https://console.tencentcloud.com/trabbitmq/cluster?rid=1), clicking Vhost in the left sidebar, and finding the Vhost name in the Vhost list.
QueueName Yes String Queue Name

3. Output Parameters

Parameter Name Type Description
InstanceId String Instance name
VirtualHost String Vhost parameter.
QueueName String Queue name.
QueueType String Queue type. Valid values: classic and quorum.
Consumers Integer The number of online consumers.

Note: this field may return null, indicating that no valid values can be obtained.
Durable Boolean Durable queue flag.
AutoDelete Boolean Automatic cleanup.
Note: this field may return null, indicating that no valid values can be obtained.
Remark String Remarks

Note: this field may return null, indicating that no valid values can be obtained.
MessageTTL Integer Messagettl parameter, specific to classic type.
Note: this field may return null, indicating that no valid values can be obtained.
AutoExpire Integer Autoexpire parameter.
Note: this field may return null, indicating that no valid values can be obtained.
MaxLength Integer The maxlength parameter specifies the maximum length.
Note: this field may return null, indicating that no valid values can be obtained.
MaxLengthBytes Integer The maxlengthbytes parameter specifies the maximum length in bytes.
Note: this field may return null, indicating that no valid values can be obtained.
DeliveryLimit Integer The deliverylimit parameter is used for quorum type.
Note: this field may return null, indicating that no valid values can be obtained.
OverflowBehaviour String The overflowbehaviour parameter specifies the behavior when overflow occurs. Valid values: drop-head, reject-publish, reject-publish-dlx.
Note: this field may return null, indicating that no valid values can be obtained.
DeadLetterExchange String The deadletterexchange parameter specifies the dead letter exchange.
Note: this field may return null, indicating that no valid values can be obtained.
DeadLetterRoutingKey String The deadletterroutingkey parameter specifies the routing key for dead letters. Valid values: [value1, value2, value3].
Note: this field may return null, indicating that no valid values can be obtained.
SingleActiveConsumer Boolean The singleactiveconsumer parameter indicates whether only one consumer can be active at a time. Valid values: [true, false].
Note: this field may return null, indicating that no valid values can be obtained.
MaximumPriority Integer The maximumpriority parameter, for classic type only, specifies the maximum priority level. Value range: 1-30.
Note: this field may return null, indicating that no valid values can be obtained.
LazyMode Boolean The lazymode parameter, for classic type only, indicates whether lazy mode is enabled. Valid values: [true, false].
Note: this field may return null, indicating that no valid values can be obtained.
MasterLocator String The masterlocator parameter, for classic type only, specifies the master locator strategy. Valid values: [strategy1, strategy2, strategy3].
Note: this field may return null, indicating that no valid values can be obtained.
MaxInMemoryLength Integer The maxinmemorylength parameter, specific to quorum type.
Note: this field may return null, indicating that no valid values can be obtained.
MaxInMemoryBytes Integer The maxinmemorybytes parameter, specific to quorum type.
Note: this field may return null, indicating that no valid values can be obtained.
CreateTime Integer Creation timestamp. Unit: seconds.
Node String Node

Note: this field may return null, indicating that no valid values can be obtained.
DeadLetterStrategy String Quorum queue dead letter consistency policy.
Note: this field may return null, indicating that no valid values can be obtained.
QueueLeaderLocator String Leader election policy for quorum queue.
Note: this field may return null, indicating that no valid values can be obtained.
QuorumInitialGroupSize Integer Initial replica group size of arbitration queue.
Note: this field may return null, indicating that no valid values can be obtained.
Exclusive Boolean Whether the queue is an exclusive queue.
Policy String Effective policy name.
Note: this field may return null, indicating that no valid values can be obtained.
Arguments String Extended parameters of the key-value type.
CreateTs Integer Creation timestamp.
ModifyTs Integer Modification timestamp.
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 Queries RabbitMQ queue details

Input Example

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

{
    "InstanceId": "amqp-jero744g",
    "VirtualHost": "tdmq_data",
    "QueueName": "prod.queue"
}

Output Example

{
    "Response": {
        "Arguments": "{\"x-ordered\": false}",
        "AutoDelete": false,
        "AutoExpire": 1000,
        "Consumers": 1,
        "CreateTime": 1728982735,
        "DeadLetterExchange": "dl-exchange",
        "DeadLetterRoutingKey": "test-dl",
        "DeadLetterStrategy": "at-most-once",
        "DeliveryLimit": null,
        "Durable": true,
        "Exclusive": false,
        "InstanceId": "amqp-jero744g",
        "LazyMode": false,
        "MasterLocator": "client-local",
        "MaxInMemoryBytes": null,
        "MaxInMemoryLength": null,
        "MaxLength": 10000,
        "MaxLengthBytes": 1000,
        "MaximumPriority": 0,
        "MessageTTL": 1000,
        "Node": "rabbit@rabbitmq-broker-0.rabbitmq-broker-internal.amqp-test.svc.cluster.local",
        "OverflowBehaviour": "drop-head",
        "Policy": "test-policy",
        "QueueLeaderLocator": null,
        "QueueName": "prod.queue",
        "QueueType": "classic",
        "QuorumInitialGroupSize": null,
        "Remark": "[System auto batch sync]",
        "RequestId": "bf6ea82d-213b-4d44-be1f-74cd31f9a22b",
        "SingleActiveConsumer": false,
        "VirtualHost": "tdmq_data"
    }
}

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.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback