Querying Queues of a Virtual Host

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

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.

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.

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 (The AMQP version does not support this parameter).

Range

N/A

arguments

QueueArguments object

Definition:

Queue parameter. This parameter is not returned if it is not configured.

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 (The AMQP version does not have this parameter because all messages are persisted by default).

Range

N/A

200

Successful