Querying All Consumer Groups
Function
This API is used to query all consumer groups.
Calling Method
For details, see Calling APIs.
URI
GET /v2/{project_id}/instances/{instance_id}/groups
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. For details about how to obtain it, see Obtaining a Project ID. |
instance_id |
Yes |
String |
Instance ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
offset |
No |
String |
Offset, which is the position where the query starts. The value must be greater than or equal to 0. |
limit |
No |
String |
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 |
Filter consumer group names that contain specific keywords. |
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
groups |
Array of GroupInfoSimple objects |
All consumer groups. |
total |
Integer |
Total number of consumer groups. |
Parameter |
Type |
Description |
---|---|---|
createdAt |
Long |
Creation time. |
group_id |
String |
Consumer group ID. |
state |
String |
Consumer group status. The value can be:
|
coordinator_id |
Integer |
Coordinator ID. |
group_desc |
String |
Consumer group description. |
lag |
Long |
Number of accumulated messages. |
Example Requests
Querying the consumer group list
GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/groups?offset={offset}&limit={limit}&group={group}
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 }
Status Codes
Status Code |
Description |
---|---|
200 |
All consumer groups are queried successfully. |
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.