Kafka Configs Kafka Protocol Wire Format API Versions KIPs Errors Kafka Upgrade Config Advisor Flink SQL
conduktor.io ↗

Kafka ListGroups Response Wire Format v5 — Binary Protocol Layout

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).

Related Errors

COORDINATOR_NOT_AVAILABLE

Wire Diagram

Response Header · flexible
message_size int32 · 4B
correlation_id int32 · 4B
tagged var
ListGroupsResponse v5
ThrottleTimeMs int32 · 4B
ErrorCode int16 · 2B
Groups array
tagged var
GroupId string (compact)
ProtocolType string (compact)
GroupState string (compact)
GroupType string (compact)
tagged var

Schema & Example

Schema
{
  "ThrottleTimeMs": int32,
  "ErrorCode": int16,
  "Groups": [{
      "GroupId": string,
      "ProtocolType": string,
      "GroupState": string,
      "GroupType": string
  }]
}
Example
{
  "ThrottleTimeMs": 0,
  "ErrorCode": 0,
  "Groups": [{
      "GroupId": "order-processors",
      "ProtocolType": "consumer",
      "GroupState": "Stable",
      "GroupType": "consumer"
  }]
}