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}
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
Parameter |
Type |
Description |
---|---|---|
group |
group object |
Consumer group information. |
Parameter |
Type |
Description |
---|---|---|
group_id |
String |
Consumer group name. |
state |
String |
Consumer group status. The value can be:
|
coordinator_id |
Integer |
Coordinator ID. |
members |
Array of members objects |
Consumer list. |
group_message_offsets |
Array of group_message_offsets objects |
Consumer offset. |
assignment_strategy |
String |
Partition assignment policy. |
Parameter |
Type |
Description |
---|---|---|
host |
String |
Consumer address. |
member_id |
String |
Consumer ID. |
client_id |
String |
Client ID. |
Parameter |
Type |
Description |
---|---|---|
partition |
Integer |
Partition number. |
lag |
Long |
Number of remaining messages that can be retrieved, that is, the number of accumulated messages. |
topic |
String |
Topic name. |
message_current_offset |
Long |
Consumer offset. |
message_log_end_offset |
Long |
Log end offset (LEO). |
Example Requests
GET https://{endpoint}/v2/{engine}/{project_id}/instances/{instance_id}/groups/{group}
Example Responses
Status code: 200
Successful
{ "group" : { "members" : [ { "host" : "/172.xx.xx.102", "member_id" : "consumer-1-6b8ee551-d499-47d4-9beb-ba1527496785", "client_id" : "consumer-1" } ], "state" : "STABLE", "group_id" : "test-consumer-group", "coordinator_id" : 2, "group_message_offsets" : [ { "partition" : 0, "lag" : 31396, "topic" : "test", "message_current_offset" : 935, "message_log_end_offset" : 32331 }, { "partition" : 0, "lag" : 0, "topic" : "aaaa", "message_current_offset" : 0, "message_log_end_offset" : 0 }, { "partition" : 1, "lag" : 31279, "topic" : "test", "message_current_offset" : 1058, "message_log_end_offset" : 32337 }, { "partition" : 1, "lag" : 0, "topic" : "aaaa", "message_current_offset" : 0, "message_log_end_offset" : 0 }, { "partition" : 2, "lag" : 31603, "topic" : "test", "message_current_offset" : 739, "message_log_end_offset" : 32342 } ], "assignment_strategy" : "range" } }
Status Codes
Status Code |
Description |
---|---|
200 |
Successful |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot