m manifester.io
All Kafka APIs

AllocateProducerIds

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 0 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
67
Encoded at
v0
Flexible versions
0+
Headers
req v2, resp v1
Request versions
0
Response versions
0
Request size
28 bytes
Response size
28 bytes
framerpc headerrequest bodyRecordBatchRecordresponse bodytagged_fields

Request

AllocateProducerIdsRequest v0, request header v2, 28 bytes on the wire

byte layout (28 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

AllocateProducerIdsRequest      message v0                                   [0x0000, 28B]
+-- Frame                                                                    [0x0000, 4B]   length-delimited framing
|   +-- size                    int32            = 24                        [0x0000, 4B]   number of bytes that follow, patched after encoding
+-- RequestHeader               v2                                           [0x0004, 11B]  common request header
|   +-- request_api_key         int16            = 67 (AllocateProducerIds)  [0x0004, 2B]   numeric id of the API being invoked
|   +-- request_api_version     int16            = 0                         [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
+-- AllocateProducerIdsRequest  struct                                       [0x000f, 13B]  message body, version 0
    +-- BrokerId                int32            = 0                         [0x000f, 4B]   The ID of the requesting broker.
    +-- BrokerEpoch             int64            = 0                         [0x0013, 8B]   The epoch of the requesting broker.
    +-- tagged_fields           uvarint          = 0                         [0x001b, 1B]   number of tagged fields in this struct

kafka message schema (.json)

{
  "apiKey": 67,
  "type": "request",
  "listeners": ["controller"],
  "name": "AllocateProducerIdsRequest",
  "validVersions": "0",
  "flexibleVersions": "0+",
  "fields": [
    { "name": "BrokerId", "type": "int32", "versions": "0+", "entityType": "brokerId",
      "about": "The ID of the requesting broker." },
    { "name": "BrokerEpoch", "type": "int64", "versions": "0+", "default": "-1",
      "about": "The epoch of the requesting broker." }
  ]
}

Response

AllocateProducerIdsResponse v0, response header v1, 28 bytes on the wire

byte layout (28 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

AllocateProducerIdsResponse      message v0        [0x0000, 28B]
+-- Frame                                          [0x0000, 4B]   length-delimited framing
|   +-- size                     int32       = 24  [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
+-- AllocateProducerIdsResponse  struct            [0x0009, 19B]  message body, version 0
    +-- 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 top level response error code.
    +-- ProducerIdStart          int64       = 0   [0x000f, 8B]   The first producer ID in this range, inclusive.
    +-- ProducerIdLen            int32       = 0   [0x0017, 4B]   The number of producer IDs in this range.
    +-- tagged_fields            uvarint     = 0   [0x001b, 1B]   number of tagged fields in this struct

kafka message schema (.json)

{
  "apiKey": 67,
  "type": "response",
  "name": "AllocateProducerIdsResponse",
  "validVersions": "0",
  "flexibleVersions": "0+",
  "fields": [
    { "name": "ThrottleTimeMs", "type": "int32", "versions": "0+",
      "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 top level response error code." },
    { "name": "ProducerIdStart", "type": "int64", "versions": "0+", "entityType": "producerId",
      "about": "The first producer ID in this range, inclusive."},
    { "name": "ProducerIdLen", "type": "int32", "versions": "0+",
      "about": "The number of producer IDs in this range."}
  ]
}