Querying a Specified Consumer Group

Function

This API is used to query a specified consumer group.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
engine	Yes	String	Engine.
project_id	Yes	String	Project ID. For details, see Obtaining a Project ID.
instance_id	Yes	String	Instance ID.
group	Yes	String	Filter query by consumer group name.

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
group	group object	Consumer group information.

**Table 3** group
Parameter	Type	Description
state	String	Definition: Consumer group status. Range: 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.
createdAt	AnyType	Definition Creation time. Range N/A
group_id	String	Definition Consumer group name. Range N/A
coordinator_id	Integer	Definition Coordinator ID. Range N/A
assignment_strategy	String	Definition Partition assignment policy. Range N/A
group_desc	String	Definition Consumer group description. Range N/A

Example Requests

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

Example Responses

Status code: 200

Successful

{
  "group" : {
    "state" : "EMPTY",
    "createdAt" : 1765333498068,
    "group_id" : "test-consumer-group",
    "coordinator_id" : 0,
    "assignment_strategy" : "",
    "group_desc" : "wefewf"
  }
}