查询队列
更新时间 2025-11-25 17:10:05
最近更新时间: 2025-11-25 17:10:05
接口功能介绍
查询队列v3
接口约束
无
URI
GET /v3/queue/query
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| prodInstId | 是 | String | 实例ID | 6b10c8b962244f1f921d1a48d0f15cca | |
| vhost | 是 | String | vhost名称 | vhost1 | |
| name | 否 | String | 队列名称 | ||
| pageNum | 否 | Integer | 分页的页序号 | 1 | |
| pageSize | 是 | Integer | 分页的大小 | 100 |
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池id | 6b10c8b962244f1f921d1a48d0f15cca |
请求体body参数 无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| returnObj | Object | 返回对象 | returnObj | |
| message | String | 描述状态 | success | |
| statusCode | String | 接口系统层面状态码。成功：800，失败：900 | 800 | |
| error | String | 错误码，描述错误信息，只有失败才显示 | AMQP_AMQP_ | |
| 表 returnObj |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| data | Object | 返回数据 | data | |
| 表 data |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| filtered_count | Integer | 按name过滤后的总队列数 | 2 | |
| item_count | Integer | 当前页面上的队列数量 | 2 | |
| items | Array of Objects | 队列详细信息 | items | |
| page | Integer | 当前页数 | 1 | |
| page_count | Integer | 总页数 | 1 | |
| page_size | Integer | 分页设置的每个页面的最多队列数 | 100 | |
| total_count | Integer | 总队列数 | 2 | |
| 表 items |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| vhost | String | 虚拟机名称 | / | |
| durable | Boolean | 是否持久化，默认持久化 | true | |
| name | String | 队列名称 | qu1 | |
| auto_delete | Boolean | 是否自动删除 | false | |
| consumers | Integer | 消费者数量 | 0 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
1
响应示例
{
"returnObj":{
"data":{
"filtered_count":2,
"item_count":2,
"items":[
{
"vhost":"/",
"durable":true,
"name":"qu1",
"auto_delete":false,
"consumers":0
},
{
"vhost":"/",
"durable":true,
"name":"test2",
"auto_delete":false,
"consumers":0
}
],
"page":1,
"page_count":1,
"page_size":100,
"total_count":2
}
},
"message":"success",
"statusCode":"800"
}
状态码
请参考 状态码
错误码
请参考 错误码
