Querying Specified Queue Details
Function
This API is used to query details of a specified queue.
URI
GET /v2/rabbitmq/{project_id}/instances/{instance_id}/vhosts/{vhost}/queues/{queue}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition Project ID. For details, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A |
instance_id |
Yes |
String |
Definition: Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body. Constraints: N/A Range: N/A Default Value: N/A |
vhost |
Yes |
String |
Definition: Virtual host name. Constraints: N/A Range: N/A Default Value: N/A |
queue |
Yes |
String |
Definition: Offset from which the query starts. Constraints: N/A Range: ≥ 0 Default Value: 0. |
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
vhost |
String |
Definition: Name of the virtual host to which the queue belongs. Range: N/A |
name |
String |
Definition: Queue name. Range: N/A |
durable |
Boolean |
Definition: Whether to enable queue persistence. Range:
|
auto_delete |
Boolean |
Definition: Whether to enable automatic queue deletion. Range:
|
messages |
Integer |
Definition: Accumulated messages. Range: N/A |
consumers |
Integer |
Definition: Connected consumers. Range: N/A |
policy |
String |
Definition: Policies. Range: N/A |
arguments |
QueueArguments object |
Definition: Queue parameter. This parameter is not returned if it is not configured. |
consumer_details |
Array of ConsumerDetails objects |
Definition: Details of subscribed consumers. |
queue_bindings |
Array of BindingsDetails objects |
Definition: Bindings to this queue. |
Parameter |
Type |
Description |
---|---|---|
x-message-ttl |
Long |
Definition: Message retention period. This parameter indicates for how long a message in this queue can be retained. Range: N/A |
x-dead-letter-exchange |
String |
Definition: Name of the dead letter exchange. Rejected and expired messages are re-sent to this exchange. Range: N/A |
x-dead-letter-routing-key |
String |
Definition: Routing key of the dead letter exchange. The dead letter exchange sends dead letter messages to the queue with a matching routing key. Range: N/A |
x-queue-mode |
String |
Definition: Lazy queue. Range: N/A |
Parameter |
Type |
Description |
---|---|---|
consumer_tag |
String |
Definition: Consumer ID. Range: N/A |
channel_details |
ChannelDetails object |
Definition: Consumer connections. Range: N/A |
ack_required |
Boolean |
Definition: Whether manual acknowledgement is enabled on the consumer client. Range:
|
prefetch_count |
Integer |
Definition: Consumer client preset value. Range: N/A |
Parameter |
Type |
Description |
---|---|---|
name |
String |
Definition: Channel details, including the client IP:Port and the server IP:Port (channel_id). Range: N/A |
number |
Integer |
Definition: Channel quantity. Range: N/A |
user |
String |
Definition: Consumer username. If ACL is enabled, the real username will be returned; otherwise null will be returned. Range: N/A |
connection_name |
String |
Definition: Connection details, including the client IP:Port and the server IP:Port. Range: N/A |
peer_host |
String |
Definition: IP address of the connected consumer. Range: N/A |
peer_port |
Integer |
Definition: Port of the process of the connected consumer. Range: N/A |
Parameter |
Type |
Description |
---|---|---|
source |
String |
Definition: Exchange name. Range: N/A |
destination_type |
String |
Definition: Type of the binding target. Range: N/A |
destination |
String |
Definition: Type of the binding target. Range: N/A |
routing_key |
String |
Definition: Binding key-value. Range: N/A |
properties_key |
String |
Definition: URL-translated routing key. Range: N/A |
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
Status code: 200
Successful
{ "vhost" : "default", "name" : "testQueue", "durable" : true, "auto_delete" : false, "messages" : 100, "consumers" : 10, "policy" : "ttl", "arguments" : { "x-message-ttl" : 60000, "x-dead-letter-exchange" : "dead-exchange-deal", "x-dead-letter-routing-key" : "dead-ex-routing-key", "x-queue-mode" : "lazy" }, "consumer_details" : { "consumer_tag" : "tag", "channel_details" : { "name" : "channel_name", "number" : 1, "user" : "root", "connection_name" : "connection_name", "peer_host" : "192.128.1.254", "peer_port" : 12345 }, "ack_required" : true, "prefetch_count" : 200 }, "queue_bindings" : { "source" : "amq.direct", "destination_type" : "queue", "destination" : "testQueue", "routing_key" : "info", "properties_key" : "info" } }
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.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot