查询指定Queue详情
功能介绍
查询指定Queue详情。
URI
GET /v2/rabbitmq/{project_id}/instances/{instance_id}/vhosts/{vhost}/queues/{queue}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,获取方式请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| instance_id | 是 | String | 参数解释: 实例ID。获取方法如下:调用“查询所有实例列表”接口,从响应体中获取实例ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| vhost | 是 | String | 参数解释: Vhost名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| queue | 是 | String | 参数解释: 分页查询偏移量,表示从此偏移量开始查询。 约束限制: 不涉及。 取值范围: 大于等于0。 默认取值: 0。 |
请求参数
无
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| vhost | String | 参数解释: Queue所属Vhost名称。 取值范围: 不涉及。 |
| name | String | 参数解释: Queue名称。 取值范围: 不涉及。 |
| durable | Boolean | 参数解释: Queue是否开启持久化。 取值范围:
|
| auto_delete | Boolean | 参数解释: Queue是否开启自动删除。 取值范围:
|
| messages | Integer | 参数解释: 待消费消息数。 取值范围: 不涉及。 |
| consumers | Integer | 参数解释: 连接的消费者数。 取值范围: 不涉及。 |
| policy | String | 参数解释: 策略。 取值范围: 不涉及。 |
| arguments | QueueArguments object | 参数解释: Queue参数,如果未配置则不返回。 |
| consumer_details | Array of ConsumerDetails objects | 参数解释: 订阅该Queue的消费者信息。 |
| queue_bindings | Array of BindingsDetails objects | 参数解释: 以此Queue为目标的绑定信息列表。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| x-message-ttl | Long | 参数解释: 消息过期时间,发布到Queue的消息在被丢弃之前可以存活多长时间。 取值范围: 不涉及。 |
| x-dead-letter-exchange | String | 参数解释: 死信Exchange名称,消息被拒绝或过期时将重新发布到该Exchange。 取值范围: 不涉及。 |
| x-dead-letter-routing-key | String | 参数解释: 死信的RoutingKey,死信Exchange会发送死信消息到绑定对应RoutingKey的Queue上。 取值范围: 不涉及。 |
| x-queue-mode | String | 参数解释: 惰性队列。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| consumer_tag | String | 参数解释: 消费者标识。 取值范围: 不涉及。 |
| channel_details | ChannelDetails object | 参数解释: 消费者连接信息。 取值范围: 不涉及。 |
| ack_required | Boolean | 参数解释: 消费者客户端是否设置手动ack。 取值范围:
|
| prefetch_count | Integer | 参数解释: 消费者客户端预取值。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| name | String | 参数解释: channel信息,包括客户端IP:Port到服务端IP:Port(channel_id)。 取值范围: 不涉及。 |
| number | Integer | 参数解释: channel数量。 取值范围: 不涉及。 |
| user | String | 参数解释: 消费者用户名,在开启ACL访问控制后返回真实用户名,未开启ACL时返回null。 取值范围: 不涉及。 |
| connection_name | String | 参数解释: connection信息,包括客户端IP:Port到服务端IP:Port。 取值范围: 不涉及。 |
| peer_host | String | 参数解释: 连接的消费者IP。 取值范围: 不涉及。 |
| peer_port | Integer | 参数解释: 连接的消费者进程端口号。 取值范围: 不涉及。 |
请求示例
查询指定Queue详情
GET https://{endpoint}/v2/rabbitmq/{project_id}/instances/{instance_id}/vhosts/{vhost}/queues?offset=0&limit=10 响应示例
状态码:200
查询指定Queue详情成功
{
"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"
}
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 查询指定Queue详情成功 |
错误码
请参见错误码。