1.接口协议:
GET https://[endpoint].ctapi.ctyun.cn/v2/queue/query
请求参数 | 是否必填 | 位置 | 参数类型 | 说明 |
prodInstId | 是 | url | String | 实例ID |
vhost | 否 | url | String | vhost名称 |
name | 否 | url | String | 队列名称 |
pageNum | 否 | url | Integer | 当前页面(默认1) |
pageSize | 否 | url | Integer | 分页大小(默认100) |
响应参数 | 参数类型 | 描述 |
statusCode | String | 接口系统层面状态码。成功:800,失败:900 |
message | String | 描述状态 |
returnObj | String | 返回对象。此参数所包含的参数请见“响应示例"里面的注释 |
返回值data参数说明
参数名 | 参数类型 | 说明 |
page | Integer | 当前页数 |
page_count | Integer | 总页数 |
page_size | Integer | 分页设置的每个页面的最多队列数 |
total_count | Integer | 总队列数 |
item_count | Integer | 当前页面上的队列数量 |
filtered_count | Integer | 按name过滤后的总队列数 |
items | List<Map<String,Object>> | 队列详细信息 |
其中items中信息如下
参数名 | 参数类型 | 说明 |
name | String | 队列名称 |
vhost | String | 虚拟机名称 |
type | String | 队列类型 |
state | String | 队列状态 |
auto_delete | Boolean | 是否自动删除 |
durable | Boolean | 是否持久化 |
consumers | Integer | 消费者数量 |
2.请求示例:
GET https://[endpoint].ctapi.ctyun.cn/v2/ queue/query?prodInstId=9b9bea76b7ce412ca18f99ccc1ea717b&vhost=/
3.返回示例:
成功响应示例
{
"returnObj": {
"data": {
"filtered_count": 2,
"item_count": 2,
"items": [
{
"vhost": "/",
"durable": true,
"name": "qu1",
"auto_delete": false,
"consumers": 0,
"state": "running",
"type": "classic"
},
{
"vhost": "/",
"durable": true,
"name": "test2",
"auto_delete": false,
"consumers": 0,
"state": "running",
"type": "classic"
}
],
"page": 1,
"page_count": 1,
"page_size": 100,
"total_count": 2
}
},
"message": "success",
"statusCode": "800"
}
失败响应示例
{
"returnObj": {},
"message": "...",
"statusCode": "900"
}