Querying Queues of a Virtual Host

Function

This API is used to query queues of a virtual host.

URI

GET /v2/rabbitmq/{project_id}/instances/{instance_id}/vhosts/{vhost}/queues

**Table 1** Path Parameters
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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Definition: Offset from which the query starts. Constraints: N/A Range: ≥ 0 Default Value: 0.
limit	No	Integer	Definition: Number of records on a page. Constraints: N/A Range: 0–50 Default Value: 10.

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
size	Integer	Definition: Number of displayed records. Range: N/A
total	Integer	Definition: Total number of queried records. Range: N/A
items	Array of QueueDetails objects	Definition: Query details.

**Table 4** QueueDetails
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: true: Yes false: No
auto_delete	Boolean	Definition: Whether to enable automatic queue deletion. Range: true: Yes false: No
messages	Integer	Definition: Accumulated messages. Range: N/A
consumers	Integer	Definition: Connected consumers. Range: N/A
policy	String	Definition: Policy. Range: N/A
arguments	QueueArguments object	Definition: Queue parameter. This parameter is not returned if it is not configured.

**Table 5** QueueArguments
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

Example Requests

Querying queues

GET https://{endpoint}/v2/rabbitmq/{project_id}/instances/{instance_id}/vhosts/{vhost}/queues?offset=0&limit=10

Example Responses

Status code: 200

Successful

{
  "size" : 1,
  "total" : 1,
  "items" : [ {
    "durable" : true,
    "name" : "queue10",
    "auto_delete" : false,
    "messages" : 0,
    "consumers" : 0,
    "arguments" : {
      "x-dead-letter-exchange" : "dead-exchange-deal",
      "x-dead-letter-routing-key" : "dead-ex-routing-key",
      "x-message-ttl" : 60000
    }
  } ]
}