ListGroups
This page encodes the smallest legal instance of the request and the response: numeric fields are zero, strings and byte arrays are empty, every array carries exactly one sample element, and any records field holds one empty 61-byte RecordBatch v2. Version 5 is a flexible version, so every struct is terminated by a uvarint tagged-field count and strings and arrays carry compact length-plus-one prefixes. Sizes below include the leading int32 size prefix.
- API key
- 16
- Encoded at
- v5
- Flexible versions
- 3+
- Headers
- req v2, resp v1
- Request versions
- 0-5
- Response versions
- 0-5
- Request size
- 20 bytes
- Response size
- 22 bytes
framerpc headerrequest bodyRecordBatchRecordresponse bodytagged_fields
Request
ListGroupsRequest v5, request header v2, 20 bytes on the wire
byte layout (20 bytes, 16 bytes per row)
0
1
2
3
4
5
6
7
8
9
A
B
C
D
E
F
0000
0010
object tree
ListGroupsRequest message v5 [0x0000, 20B] +-- Frame [0x0000, 4B] length-delimited framing | +-- size int32 = 16 [0x0000, 4B] number of bytes that follow, patched after encoding +-- RequestHeader v2 [0x0004, 11B] common request header | +-- request_api_key int16 = 16 (ListGroups) [0x0004, 2B] numeric id of the API being invoked | +-- request_api_version int16 = 5 [0x0006, 2B] version of the API being invoked | +-- correlation_id int32 = 0 [0x0008, 4B] echoed back by the broker in the response | +-- client_id nullable_string = "" (int16 len=0) [0x000c, 2B] always a non-flexible int16-prefixed string | +-- tagged_fields uvarint = 0 [0x000e, 1B] number of tagged fields in the header +-- ListGroupsRequest struct [0x000f, 5B] message body, version 5 +-- StatesFilter []string = 1 element [0x000f, 2B] The states of the groups we want to list. If empty, all groups are returned... | +-- length uvarint = 2 (compact, n+1) [0x000f, 1B] one sample element follows | +-- string[0] string = "" (compact, len+1=1) [0x0010, 1B] +-- TypesFilter []string = 1 element [0x0011, 2B] The types of the groups we want to list. If empty, all groups are returned ... | +-- length uvarint = 2 (compact, n+1) [0x0011, 1B] one sample element follows | +-- string[0] string = "" (compact, len+1=1) [0x0012, 1B] +-- tagged_fields uvarint = 0 [0x0013, 1B] number of tagged fields in this struct
kafka message schema (.json)
{ "apiKey": 16, "type": "request", "listeners": ["broker"], "name": "ListGroupsRequest", // Version 1 and 2 are the same as version 0. // // Version 3 is the first flexible version. // // Version 4 adds the StatesFilter field (KIP-518). // // Version 5 adds the TypesFilter field (KIP-848). "validVersions": "0-5", "flexibleVersions": "3+", "fields": [ { "name": "StatesFilter", "type": "[]string", "versions": "4+", "about": "The states of the groups we want to list. If empty, all groups are returned with their state." }, { "name": "TypesFilter", "type": "[]string", "versions": "5+", "about": "The types of the groups we want to list. If empty, all groups are returned with their type." } ] }
Response
ListGroupsResponse v5, response header v1, 22 bytes on the wire
byte layout (22 bytes, 16 bytes per row)
0
1
2
3
4
5
6
7
8
9
A
B
C
D
E
F
0000
0010
object tree
ListGroupsResponse message v5 [0x0000, 22B] +-- Frame [0x0000, 4B] length-delimited framing | +-- size int32 = 18 [0x0000, 4B] number of bytes that follow, patched after encoding +-- ResponseHeader v1 [0x0004, 5B] common response header | +-- correlation_id int32 = 0 [0x0004, 4B] matches the correlation_id of the request | +-- tagged_fields uvarint = 0 [0x0008, 1B] number of tagged fields in the header +-- ListGroupsResponse struct [0x0009, 13B] message body, version 5 +-- ThrottleTimeMs int32 = 0 [0x0009, 4B] The duration in milliseconds for which the request was throttled due to a q... +-- ErrorCode int16 = 0 [0x000d, 2B] The error code, or 0 if there was no error. +-- Groups []ListedGroup = 1 element [0x000f, 6B] Each group in the response. | +-- length uvarint = 2 (compact, n+1) [0x000f, 1B] one sample element follows | +-- ListedGroup[0] ListedGroup = struct [0x0010, 5B] | +-- GroupId string = "" (compact, len+1=1) [0x0010, 1B] The group ID. | +-- ProtocolType string = "" (compact, len+1=1) [0x0011, 1B] The group protocol type. | +-- GroupState string = "" (compact, len+1=1) [0x0012, 1B] The group state name. | +-- GroupType string = "" (compact, len+1=1) [0x0013, 1B] The group type name. | +-- tagged_fields uvarint = 0 [0x0014, 1B] number of tagged fields in this struct +-- tagged_fields uvarint = 0 [0x0015, 1B] number of tagged fields in this struct
kafka message schema (.json)
{ "apiKey": 16, "type": "response", "name": "ListGroupsResponse", // Version 1 adds the throttle time. // // Starting in version 2, on quota violation, brokers send out // responses before throttling. // // Version 3 is the first flexible version. // // Version 4 adds the GroupState field (KIP-518). // // Version 5 adds the GroupType field (KIP-848). "validVersions": "0-5", "flexibleVersions": "3+", "fields": [ { "name": "ThrottleTimeMs", "type": "int32", "versions": "1+", "ignorable": true, "about": "The duration in milliseconds for which the request was throttled due to a quota violation, or zero if the request did not violate any quota." }, { "name": "ErrorCode", "type": "int16", "versions": "0+", "about": "The error code, or 0 if there was no error." }, { "name": "Groups", "type": "[]ListedGroup", "versions": "0+", "about": "Each group in the response.", "fields": [ { "name": "GroupId", "type": "string", "versions": "0+", "entityType": "groupId", "about": "The group ID." }, { "name": "ProtocolType", "type": "string", "versions": "0+", "about": "The group protocol type." }, { "name": "GroupState", "type": "string", "versions": "4+", "ignorable": true, "about": "The group state name." }, { "name": "GroupType", "type": "string", "versions": "5+", "ignorable": true, "about": "The group type name." } ]} ] }