Querying Consumer Group Details

This API is used to query consumer group details.

For details, see Calling APIs.

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition: Project ID. For details, see Obtaining a Project ID. Constraints: N/A Range: N/A Default Value: N/A
instance_id	Yes	String	Definition: Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body. Constraints: N/A Range: N/A Default Value: N/A
group	Yes	String	Definition: Consumer group name. Constraints: N/A Range: N/A Default Value: N/A

None

Status code: 200

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

**Table 3** group
Parameter	Type	Description
group_id	String	Definition: Consumer group name. Range: N/A
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.
coordinator_id	Integer	Definition: Coordinator ID. Range: N/A
members	Array of members objects	Definition: Consumer list.
group_message_offsets	Array of group_message_offsets objects	Definition: Consumer offset.
assignment_strategy	String	Definition: Partition assignment policy. Range: N/A

**Table 4** members
Parameter	Type	Description
host	String	Definition: Consumer address of a consumer group. Range: N/A
assignment	Array of assignment objects	Definition: Details about the partition assigned to the consumer.
member_id	String	Definition: Consumer ID of a consumer group. Range: N/A
client_id	String	Definition: Client ID. Range: N/A

**Table 5** assignment
Parameter	Type	Description
topic	String	Definition: Topic name. Range: N/A
partitions	Array of integers	Definition: Partition list.

**Table 6** group_message_offsets
Parameter	Type	Description
partition	Integer	Definition: Partition ID. Range: N/A
lag	Long	Definition: Number of remaining messages that can be consumed, that is, the number of accumulated messages. Range: N/A
topic	String	Definition: Topic name. Range: N/A
message_current_offset	Long	Definition: Current consumer offset. Range: N/A
message_log_end_offset	Long	Definition: Log end offset (LEO). Range: N/A

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

Status code: 200

The consumer group details are queried successfully.

{
  "group" : {
    "state" : "STABLE",
    "group_id" : "test-consumer-group",
    "coordinator_id" : 2,
    "assignment_strategy" : "range"
  }
}

Status Code	Description
200	The consumer group details are queried successfully.

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel