Querying All Consumer Groups

Function

This API is used to query all consumer groups.

Call Method

For details, see How to Call an API.

URI

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

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
engine	Yes	String	Indicates the message engine.
project_id	Yes	String	Project ID. For details, see Obtaining a Project ID.
instance_id	Yes	String	Instance 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 greater than or equal to 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

None.

Response

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
groups	Array of GroupInfoSimple objects	All consumer groups
total	Integer	Total number of consumer groups

**Table 4** GroupInfoSimple
Parameter	Type	Description
createdAt	Long	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 member. PreparingRebalance: The consumer group is to be rebalanced. CompletingRebalance: All members have jointed the group. Stable: Members in the consumption group can consume messages normally.
coordinator_id	Integer	Coordinator ID
group_desc	String	Consumer group description
lag	Long	Accumulated messages

Example Request

GET https://{endpoint}/v2/{engine}/{project_id}/instances/{instance_id}/groups

Example Response

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
}