查看指定队列的所有消费组
功能介绍
获取指定队列的所有消费组。
URI
GET /v1.0/{project_id}/queues/{queue_id}/groups?include_deadletter={include_deadletter}&include_messages_num={boolean}&page_size={page_size}¤t_page={current_page}
参数说明请参见表1。
|
名称 |
类型 |
是否必选 |
说明 |
|---|---|---|---|
|
project_id |
String |
是 |
项目ID。 |
|
queue_id |
String |
是 |
指定的队列ID。 |
|
include_deadletter |
Boolean |
否 |
是否包含死信信息。默认值为：false。 |
|
include_messages_num |
Boolean |
否 |
是否查询消费组的详情，默认值为true。 配置为false时，查询的消费组列表不包含消费详情，接口响应速度快。 |
|
page_size |
Integer |
否 |
设置每页显示的消费组数量。 page_size和current_page必须同时配置有效值，否则默认查询所有消费组。 |
|
current_page |
Integer |
否 |
设置查询消费组的页码。 page_size和current_page必须同时配置有效值，否则默认查询所有消费组。 |
GET v1.0/b78a90ae2a134b4b8b2ba30acab4e23a/queues/075ae7da-6ce5-4966-940c-17c19fb5175e/groups?include_deadletter=true
请求消息
请求参数
无。
请求示例
无。
响应消息
响应参数
|
参数 |
类型 |
描述 |
|---|---|---|
|
queue_id |
String |
队列ID。 |
|
queue_name |
String |
队列的名称。 |
|
groups |
Array |
消费组列表。 |
|
redrive_policy |
String |
该队列是否开启死信消息。仅当include_deadletter为true时，才有该响应参数。
|
|
参数 |
类型 |
描述 |
|---|---|---|
|
id |
String |
消费组的ID。 |
|
name |
String |
消费组的名称。 |
|
produced_messages |
Integer |
队列的消息总数，不包含过期删除的消息数。 |
|
consumed_messages |
Integer |
已正常消费的消息总数。 |
|
available_messages |
Integer |
该消费组可以消费的普通消息数。 |
|
produced_deadletters |
Integer |
该消费组产生的死信息消息总数。仅当include_deadletter为true时，才有该响应参数。 |
|
available_deadletters |
Integer |
该消费组未消费的死信消息数。仅当include_deadletter为true时，才有该响应参数。 |
响应示例
{
"queue_name" : "queue-772289871",
"groups" : [{
"name" : "group-1690260950",
"id" : "g-eb9305bb-5bec-4712-84ab-0a36fbe9c2c0",
"consumed_messages" : 0,
"available_messages" : 8,
"produced_messages" : 10,
}
],
"redrive_policy" : "enable",
"queue_id" : "f5b6dd28-08dd-4f0f-866c-2eadf6788163"
}
{
"queue_name" : "queue-586845368",
"groups" : [{
"name" : "group-364417183",
"id" : "g-33d53064-2ab9-4acc-8566-3faa8c8578bf",
"consumed_messages" : 0,
"available_messages" : 0,
"produced_messages" : 0,
}, {
"name" : "group-1722391629",
"id" : "g-876fc3a2-e8c1-4a81-af3e-9ef68e3e46cf",
"consumed_messages" : 0,
"available_messages" : 0,
"produced_messages" : 0,
}
],
"queue_id" : "e7e6d7f6-c555-470a-b9ee-3175e3408250"
}
