What is ListGroups?
Enumerates all consumer groups known to a broker, used by kafka-consumer-groups.sh --list. Each broker only knows about groups it coordinates, so you must query all brokers for the complete picture (AdminClient does this automatically).
| Version | Kafka | Changes |
|---|---|---|
| ListGroupsRequest | ||
| v0 | 2.2 | No changes |
| v1 | 2.2 | are the same as version 0. |
| v2 | 2.2 | are the same as version 0. |
| v3 | 2.4 | ~ Flexible encoding enabled FLEXIBLE is the first flexible version. |
| v4 | 2.6 | + StatesFilter []stringadds the StatesFilter field (KIP-518). |
| v5 | 3.8 | + TypesFilter []stringadds the TypesFilter field (KIP-848). |
| ListGroupsResponse | ||
| v0 | 2.2 | + ErrorCode int16+ Groups []ListedGroup+ GroupId string+ ProtocolType string |
| v1 | 2.2 | + ThrottleTimeMs int32adds the throttle time. |
| v2 | 2.2 | on quota violation, brokers send out responses before throttling. |
| v3 | 2.4 | ~ Flexible encoding enabled FLEXIBLE is the first flexible version. |
| v4 | 2.6 | + GroupState stringadds the GroupState field (KIP-518). |
| v5 | 3.8 | + GroupType stringadds the GroupType field (KIP-848). |