Querying Specified Queue Details

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.

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.

consumer_details

Array of ConsumerDetails objects

Definition:

Details of subscribed consumers.

queue_bindings

Array of BindingsDetails objects

Definition:

Bindings to this queue.

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

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:

• true: Yes

• false: No

prefetch_count

Integer

Definition:

Consumer client preset value.

Range:

N/A

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

source

String

Definition:

Exchange name.

Range:

N/A

destination_type

String

Definition

Type of the binding target.

Range

• exchange

• queue

destination

String

Definition

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

200

Successful