更新时间:2025-12-23 GMT+08:00

查询所属Vhost下Queue的列表

功能介绍

查询所属Vhost下Queue的列表。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID,获取方式请参见获取项目ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

instance_id

是

String

参数解释:

实例ID。获取方法如下:调用“查询所有实例列表”接口,从响应体中获取实例ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

vhost

是

String

参数解释:

Vhost名称。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

参数解释:

分页查询偏移量,表示从此偏移量开始查询。

约束限制:

不涉及。

取值范围:

大于等于0。

默认取值:

0。

limit

否

Integer

参数解释:

分页查询单页数量。

约束限制:

不涉及。

取值范围:

0~50。

默认取值:

10。

请求参数

无

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

size

Integer

参数解释:

当前显示数量。

取值范围:

不涉及。

total

Integer

参数解释:

查询结果总数。

取值范围:

不涉及。

items

Array of QueueDetails objects

参数解释:

查询详情。

表4 QueueDetails

参数

参数类型

描述

vhost

String

参数解释:

Queue所属Vhost名称。

取值范围:

不涉及。

name

String

参数解释:

Queue名称。

取值范围:

不涉及。

durable

Boolean

参数解释:

Queue是否开启持久化。

取值范围:

  • true:开启持久化。

  • false:未开启持久化。

auto_delete

Boolean

参数解释:

Queue是否开启自动删除。

取值范围:

  • true:开启自动删除。

  • false:未开启自动删除。

messages

Integer

参数解释:

待消费消息数。

取值范围:

不涉及。

consumers

Integer

参数解释:

连接的消费者数。

取值范围:

不涉及。

policy

String

参数解释:

策略。

取值范围:

不涉及。

arguments

QueueArguments object

参数解释:

Queue参数,如果未配置则不返回。

表5 QueueArguments

参数

参数类型

描述

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

参数解释:

惰性队列。

取值范围:

不涉及。

请求示例

查询Queue列表

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

响应示例

状态码:200

获取Queue列表成功

{
  "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
    }
  } ]
}

状态码

状态码

描述

200

获取Queue列表成功

错误码

请参见错误码。