DescribeQuorum
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 2 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
- 55
- Encoded at
- v2
- Flexible versions
- 0+
- Headers
- req v2, resp v1
- Request versions
- 0-2
- Response versions
- 0-2
- Request size
- 25 bytes
- Response size
- 145 bytes
framerpc headerrequest bodyRecordBatchRecordresponse bodytagged_fields
Request
DescribeQuorumRequest v2, request header v2, 25 bytes on the wire
byte layout (25 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
DescribeQuorumRequest message v2 [0x0000, 25B] +-- Frame [0x0000, 4B] length-delimited framing | +-- size int32 = 21 [0x0000, 4B] number of bytes that follow, patched after encoding +-- RequestHeader v2 [0x0004, 11B] common request header | +-- request_api_key int16 = 55 (DescribeQuorum) [0x0004, 2B] numeric id of the API being invoked | +-- request_api_version int16 = 2 [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 +-- DescribeQuorumRequest struct [0x000f, 10B] message body, version 2 +-- Topics []TopicData = 1 element [0x000f, 9B] The topics to describe. | +-- length uvarint = 2 (compact, n+1) [0x000f, 1B] one sample element follows | +-- TopicData[0] TopicData = struct [0x0010, 8B] | +-- TopicName string = "" (compact, len+1=1) [0x0010, 1B] The topic name. | +-- Partitions []PartitionData = 1 element [0x0011, 6B] The partitions to describe. | | +-- length uvarint = 2 (compact, n+1) [0x0011, 1B] one sample element follows | | +-- PartitionData[0] PartitionData = struct [0x0012, 5B] | | +-- PartitionIndex int32 = 0 [0x0012, 4B] The partition index. | | +-- tagged_fields uvarint = 0 [0x0016, 1B] number of tagged fields in this struct | +-- tagged_fields uvarint = 0 [0x0017, 1B] number of tagged fields in this struct +-- tagged_fields uvarint = 0 [0x0018, 1B] number of tagged fields in this struct
kafka message schema (.json)
{ "apiKey": 55, "type": "request", "listeners": ["broker", "controller"], "name": "DescribeQuorumRequest", // Version 1 adds additional fields in the response. The request is unchanged (KIP-836). // Version 2 adds additional fields in the response. The request is unchanged (KIP-853). "validVersions": "0-2", "flexibleVersions": "0+", "latestVersionUnstable": false, "fields": [ { "name": "Topics", "type": "[]TopicData", "versions": "0+", "about": "The topics to describe.", "fields": [ { "name": "TopicName", "type": "string", "versions": "0+", "entityType": "topicName", "about": "The topic name." }, { "name": "Partitions", "type": "[]PartitionData", "versions": "0+", "about": "The partitions to describe.", "fields": [ { "name": "PartitionIndex", "type": "int32", "versions": "0+", "about": "The partition index." } ] }] } ] }
Response
DescribeQuorumResponse v2, response header v1, 145 bytes on the wire
byte layout (145 bytes, 16 bytes per row)
0
1
2
3
4
5
6
7
8
9
A
B
C
D
E
F
0000
0010
0020
0030
0040
0050
0060
0070
0080
0090
object tree
DescribeQuorumResponse message v2 [0x0000, 145B] +-- Frame [0x0000, 4B] length-delimited framing | +-- size int32 = 141 [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 +-- DescribeQuorumResponse struct [0x0009, 136B] message body, version 2 +-- ErrorCode int16 = 0 [0x0009, 2B] The top level error code. +-- ErrorMessage string = "" (compact, len+1=1) [0x000b, 1B] The error message, or null if there was no error. +-- Topics []TopicData = 1 element [0x000c, 120B] The response from the describe quorum API. | +-- length uvarint = 2 (compact, n+1) [0x000c, 1B] one sample element follows | +-- TopicData[0] TopicData = struct [0x000d, 119B] | +-- TopicName string = "" (compact, len+1=1) [0x000d, 1B] The topic name. | +-- Partitions []PartitionData = 1 element [0x000e, 117B] The partition data. | | +-- length uvarint = 2 (compact, n+1) [0x000e, 1B] one sample element follows | | +-- PartitionData[0] PartitionData = struct [0x000f, 116B] | | +-- PartitionIndex int32 = 0 [0x000f, 4B] The partition index. | | +-- ErrorCode int16 = 0 [0x0013, 2B] The partition error code. | | +-- ErrorMessage string = "" (compact, len+1=1) [0x0015, 1B] The error message, or null if there was no error. | | +-- LeaderId int32 = 0 [0x0016, 4B] The ID of the current leader or -1 if the leader is unknown. | | +-- LeaderEpoch int32 = 0 [0x001a, 4B] The latest known leader epoch. | | +-- HighWatermark int64 = 0 [0x001e, 8B] The high water mark. | | +-- CurrentVoters []ReplicaState = 1 element [0x0026, 46B] The current voters of the partition. | | | +-- length uvarint = 2 (compact, n+1) [0x0026, 1B] one sample element follows | | | +-- ReplicaState[0] ReplicaState = struct [0x0027, 45B] | | | +-- ReplicaId int32 = 0 [0x0027, 4B] The ID of the replica. | | | +-- ReplicaDirectoryId uuid = 00000000-0000-0000-0000-000000000000 [0x002b, 16B] The replica directory ID of the replica. | | | +-- LogEndOffset int64 = 0 [0x003b, 8B] The last known log end offset of the follower or -1 if it is unknown. | | | +-- LastFetchTimestamp int64 = 0 [0x0043, 8B] The last known leader wall clock time time when a follower fetched from the... | | | +-- LastCaughtUpTimestamp int64 = 0 [0x004b, 8B] The leader wall clock append time of the offset for which the follower made... | | | +-- tagged_fields uvarint = 0 [0x0053, 1B] number of tagged fields in this struct | | +-- Observers []ReplicaState = 1 element [0x0054, 46B] The observers of the partition. | | | +-- length uvarint = 2 (compact, n+1) [0x0054, 1B] one sample element follows | | | +-- ReplicaState[0] ReplicaState = struct [0x0055, 45B] | | | +-- ReplicaId int32 = 0 [0x0055, 4B] The ID of the replica. | | | +-- ReplicaDirectoryId uuid = 00000000-0000-0000-0000-000000000000 [0x0059, 16B] The replica directory ID of the replica. | | | +-- LogEndOffset int64 = 0 [0x0069, 8B] The last known log end offset of the follower or -1 if it is unknown. | | | +-- LastFetchTimestamp int64 = 0 [0x0071, 8B] The last known leader wall clock time time when a follower fetched from the... | | | +-- LastCaughtUpTimestamp int64 = 0 [0x0079, 8B] The leader wall clock append time of the offset for which the follower made... | | | +-- tagged_fields uvarint = 0 [0x0081, 1B] number of tagged fields in this struct | | +-- tagged_fields uvarint = 0 [0x0082, 1B] number of tagged fields in this struct | +-- tagged_fields uvarint = 0 [0x0083, 1B] number of tagged fields in this struct +-- Nodes []Node = 1 element [0x0084, 12B] The nodes in the quorum. | +-- length uvarint = 2 (compact, n+1) [0x0084, 1B] one sample element follows | +-- Node[0] Node = struct [0x0085, 11B] | +-- NodeId int32 = 0 [0x0085, 4B] The ID of the associated node. | +-- Listeners []Listener = 1 element [0x0089, 6B] The listeners of this controller. | | +-- length uvarint = 2 (compact, n+1) [0x0089, 1B] one sample element follows | | +-- Listener[0] Listener = struct [0x008a, 5B] | | +-- Name string = "" (compact, len+1=1) [0x008a, 1B] The name of the endpoint. | | +-- Host string = "" (compact, len+1=1) [0x008b, 1B] The hostname. | | +-- Port uint16 = 0 [0x008c, 2B] The port. | | +-- tagged_fields uvarint = 0 [0x008e, 1B] number of tagged fields in this struct | +-- tagged_fields uvarint = 0 [0x008f, 1B] number of tagged fields in this struct +-- tagged_fields uvarint = 0 [0x0090, 1B] number of tagged fields in this struct
kafka message schema (.json)
{ "apiKey": 55, "type": "response", "name": "DescribeQuorumResponse", // Version 1 adds LastFetchTimeStamp and LastCaughtUpTimestamp in ReplicaState (KIP-836). // Version 2 adds ErrorMessage, Nodes, ErrorMessage in ParitionData, ReplicaDirectoryId in ReplicaState (KIP-853). "validVersions": "0-2", "flexibleVersions": "0+", "fields": [ { "name": "ErrorCode", "type": "int16", "versions": "0+", "about": "The top level error code."}, { "name": "ErrorMessage", "type": "string", "versions": "2+", "nullableVersions": "2+", "ignorable": true, "about": "The error message, or null if there was no error." }, { "name": "Topics", "type": "[]TopicData", "versions": "0+", "about": "The response from the describe quorum API.", "fields": [ { "name": "TopicName", "type": "string", "versions": "0+", "entityType": "topicName", "about": "The topic name." }, { "name": "Partitions", "type": "[]PartitionData", "versions": "0+", "about": "The partition data.", "fields": [ { "name": "PartitionIndex", "type": "int32", "versions": "0+", "about": "The partition index." }, { "name": "ErrorCode", "type": "int16", "versions": "0+", "about": "The partition error code."}, { "name": "ErrorMessage", "type": "string", "versions": "2+", "nullableVersions": "2+", "ignorable": true, "about": "The error message, or null if there was no error." }, { "name": "LeaderId", "type": "int32", "versions": "0+", "entityType": "brokerId", "about": "The ID of the current leader or -1 if the leader is unknown."}, { "name": "LeaderEpoch", "type": "int32", "versions": "0+", "about": "The latest known leader epoch."}, { "name": "HighWatermark", "type": "int64", "versions": "0+", "about": "The high water mark."}, { "name": "CurrentVoters", "type": "[]ReplicaState", "versions": "0+", "about": "The current voters of the partition."}, { "name": "Observers", "type": "[]ReplicaState", "versions": "0+", "about": "The observers of the partition."} ]} ]}, { "name": "Nodes", "type": "[]Node", "versions": "2+", "about": "The nodes in the quorum.", "fields": [ { "name": "NodeId", "type": "int32", "versions": "2+", "mapKey": true, "entityType": "brokerId", "about": "The ID of the associated node." }, { "name": "Listeners", "type": "[]Listener", "about": "The listeners of this controller.", "versions": "2+", "fields": [ { "name": "Name", "type": "string", "versions": "2+", "mapKey": true, "about": "The name of the endpoint." }, { "name": "Host", "type": "string", "versions": "2+", "about": "The hostname." }, { "name": "Port", "type": "uint16", "versions": "2+", "about": "The port." } ]} ]} ], "commonStructs": [ { "name": "ReplicaState", "versions": "0+", "fields": [ { "name": "ReplicaId", "type": "int32", "versions": "0+", "entityType": "brokerId", "about": "The ID of the replica."}, { "name": "ReplicaDirectoryId", "type": "uuid", "versions": "2+", "about": "The replica directory ID of the replica."}, { "name": "LogEndOffset", "type": "int64", "versions": "0+", "about": "The last known log end offset of the follower or -1 if it is unknown."}, { "name": "LastFetchTimestamp", "type": "int64", "versions": "1+", "ignorable": true, "default": -1, "about": "The last known leader wall clock time time when a follower fetched from the leader. This is reported as -1 both for the current leader or if it is unknown for a voter."}, { "name": "LastCaughtUpTimestamp", "type": "int64", "versions": "1+", "ignorable": true, "default": -1, "about": "The leader wall clock append time of the offset for which the follower made the most recent fetch request. This is reported as the current time for the leader and -1 if unknown for a voter."} ]} ] }