Querying Specified Queue Details
Function
This API is used to query details of a specified queue.
Calling Method
For details, see Calling APIs.
URI
GET /v2/rabbitmq/{project_id}/instances/{instance_id}/vhosts/{vhost}/queues/{queue}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. |
instance_id |
Yes |
String |
Instance ID. |
vhost |
Yes |
String |
Virtual host name. |
queue |
Yes |
String |
Queue name. |
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
vhost |
String |
Virtual host name. |
name |
String |
Queue name. |
durable |
Boolean |
Indicates whether data persistence is enabled. |
auto_delete |
Boolean |
Indicates whether automatic deletion is enabled. |
messages |
Integer |
Accumulated messages. |
consumers |
Integer |
Connected consumers. |
policy |
String |
Policy. |
arguments |
QueueArguments object |
Queue parameter. This parameter is not returned if it is not configured. |
consumer_details |
Array of ConsumerDetails objects |
Details of subscribed consumers. |
queue_bindings |
Array of BindingsDetails objects |
Bindings to this queue. |
Parameter |
Type |
Description |
---|---|---|
x-message-ttl |
Long |
Message retention period. This parameter indicates for how long a message in this queue can be retained. |
x-dead-letter-exchange |
String |
Name of the dead letter exchange. Rejected and expired messages are re-sent to this exchange. |
x-dead-letter-routing-key |
String |
Routing key of the dead letter exchange. The dead letter exchange sends dead letter messages to the queue with a matching routing key. |
x-queue-mode |
String |
Lazy queue. |
Parameter |
Type |
Description |
---|---|---|
consumer_tag |
String |
Consumer tag. |
channel_details |
ChannelDetails object |
Consumer connections. |
ack_required |
Boolean |
Indicates whether manual acknowledgement is enabled on the consumer client. |
prefetch_count |
Integer |
Consumer client preset value. |
Parameter |
Type |
Description |
---|---|---|
name |
String |
Channel details, including the client IP:Port and the server IP:Port (channel_id). |
number |
Integer |
Channel quantity. |
user |
String |
Consumer username. If ACL is enabled, the real username will be returned; otherwise null will be returned. |
connection_name |
String |
Connection details, including the client IP:Port and the server IP:Port. |
peer_host |
String |
IP address of the connected consumer. |
peer_port |
Integer |
Port of the process of the connected consumer. |
Example Requests
Querying specified queue details
GET https://{endpoint}/v2/rabbitmq/{project_id}/instances/{instance_id}/vhosts/{vhost}/queues?offset=0&limit=10
Example Responses
None
Status Codes
Status Code |
Description |
---|---|
200 |
Successful |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.