Querying All Consumer Groups

Function

This API is used to query all consumer groups.

URI

GET /v2/{project_id}/mqs/instances/{instance_id}/groups

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
instance_id	Yes	String	Instance ID
project_id	Yes	String	Project ID

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Offset, which is the position where the query starts. The value must be no less than 0.
limit	No	Integer	Maximum number of consumer group IDs returned in the current query. The default value is 10. The value ranges from 1 to 50.
group	No	String	Filtering consumer group names that contain specific keywords.
topic	No	String	If a topic is specified, only the consumer groups of the topic are queried.

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
[items]	Array of ListInstanceGroupResp objects	Consumer group information

**Table 4** ListInstanceGroupResp
Parameter	Type	Description
groups	Array of ListGroupEntity objects	All consumer groups
total	Integer	Total number of consumer groups.

**Table 5** ListGroupEntity
Parameter	Type	Description
createdAt	Integer	Creation time
group_id	String	Consumer group ID
state	String	Consumer group status. The value can be: Dead: The consumer group has no members and no metadata. Empty: The consumer group has metadata but has no members. PreparingRebalance: The consumer group is to be rebalanced. CompletingRebalance: All members have joined the group. Stable: Members in the consumer group can consume messages normally.
coordinator_id	Integer	Coordinator ID
group_desc	String	Consumer group description
lag	Integer	Accumulated messages

Example Requests

None

Example Responses

Status code: 200

All consumer groups are queried successfully.

{
  "groups" : [ {
    "createdAt" : 1691401194847,
    "group_id" : "consumer-1",
    "state" : "EMPTY",
    "coordinator_id" : 1,
    "lag" : 0,
    "group_desc" : null
  }, {
    "createdAt" : 1691401194960,
    "group_id" : "consumer-2",
    "state" : "STABLE",
    "coordinator_id" : 2,
    "lag" : 0,
    "group_desc" : null
  }, {
    "createdAt" : 1691401207309,
    "group_id" : "consumer-3",
    "state" : "STABLE",
    "coordinator_id" : 3,
    "lag" : 0,
    "group_desc" : null
  } ],
  "total" : 3
}