Skip to content
m manifester.io
All Kafka APIs

DescribeProducers

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

Request

DescribeProducersRequest v0, request header v2, 24 bytes on the wire

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

DescribeProducersRequest          message v0                                 [0x0000, 24B]
+-- Frame                                                                    [0x0000, 4B]   length-delimited framing
|   +-- size                      int32            = 20                      [0x0000, 4B]   number of bytes that follow, patched after encoding
+-- RequestHeader                 v2                                         [0x0004, 11B]  common request header
|   +-- request_api_key           int16            = 61 (DescribeProducers)  [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
+-- DescribeProducersRequest      struct                                     [0x000f, 9B]   message body, version 0
    +-- Topics                    []TopicRequest   = 1 element               [0x000f, 8B]   The topics to list producers for.
    |   +-- length                uvarint          = 2 (compact, n+1)        [0x000f, 1B]   one sample element follows
    |   +-- TopicRequest[0]       TopicRequest     = struct                  [0x0010, 7B]
    |       +-- Name              string           = "" (compact, len+1=1)   [0x0010, 1B]   The topic name.
    |       +-- PartitionIndexes  []int32          = 1 element               [0x0011, 5B]   The indexes of the partitions to list producers for.
    |       |   +-- length        uvarint          = 2 (compact, n+1)        [0x0011, 1B]   one sample element follows
    |       |   +-- int32[0]      int32            = 0                       [0x0012, 4B]
    |       +-- 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

kafka message schema (.json)

{
  "apiKey": 61,
  "type": "request",
  "listeners": ["broker"],
  "name": "DescribeProducersRequest",
  "validVersions": "0",
  "flexibleVersions": "0+",
  "fields": [
    { "name": "Topics", "type": "[]TopicRequest", "versions": "0+",
      "about": "The topics to list producers for.", "fields": [
      { "name": "Name", "type": "string", "versions": "0+", "entityType": "topicName",
        "about": "The topic name." },
      { "name": "PartitionIndexes", "type": "[]int32", "versions": "0+",
        "about": "The indexes of the partitions to list producers for." }
     ]}
  ]
}

Response

DescribeProducersResponse v0, response header v1, 64 bytes on the wire

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

object tree

DescribeProducersResponse                              message v0                                    [0x0000, 64B]
+-- Frame                                                                                            [0x0000, 4B]   length-delimited framing
|   +-- size                                           int32                = 60                     [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
+-- DescribeProducersResponse                          struct                                        [0x0009, 55B]  message body, version 0
    +-- ThrottleTimeMs                                 int32                = 0                      [0x0009, 4B]   The duration in milliseconds for which the request was throttled due to a q...
    +-- Topics                                         []TopicResponse      = 1 element              [0x000d, 50B]  Each topic in the response.
    |   +-- length                                     uvarint              = 2 (compact, n+1)       [0x000d, 1B]   one sample element follows
    |   +-- TopicResponse[0]                           TopicResponse        = struct                 [0x000e, 49B]
    |       +-- Name                                   string               = "" (compact, len+1=1)  [0x000e, 1B]   The topic name.
    |       +-- Partitions                             []PartitionResponse  = 1 element              [0x000f, 47B]  Each partition in the response.
    |       |   +-- length                             uvarint              = 2 (compact, n+1)       [0x000f, 1B]   one sample element follows
    |       |   +-- PartitionResponse[0]               PartitionResponse    = struct                 [0x0010, 46B]
    |       |       +-- PartitionIndex                 int32                = 0                      [0x0010, 4B]   The partition index.
    |       |       +-- ErrorCode                      int16                = 0                      [0x0014, 2B]   The partition error code, or 0 if there was no error.
    |       |       +-- ErrorMessage                   string               = "" (compact, len+1=1)  [0x0016, 1B]   The partition error message, which may be null if no additional details are...
    |       |       +-- ActiveProducers                []ProducerState      = 1 element              [0x0017, 38B]  The active producers for the partition.
    |       |       |   +-- length                     uvarint              = 2 (compact, n+1)       [0x0017, 1B]   one sample element follows
    |       |       |   +-- ProducerState[0]           ProducerState        = struct                 [0x0018, 37B]
    |       |       |       +-- ProducerId             int64                = 0                      [0x0018, 8B]   The producer id.
    |       |       |       +-- ProducerEpoch          int32                = 0                      [0x0020, 4B]   The producer epoch.
    |       |       |       +-- LastSequence           int32                = 0                      [0x0024, 4B]   The last sequence number sent by the producer.
    |       |       |       +-- LastTimestamp          int64                = 0                      [0x0028, 8B]   The last timestamp sent by the producer.
    |       |       |       +-- CoordinatorEpoch       int32                = 0                      [0x0030, 4B]   The current epoch of the producer group.
    |       |       |       +-- CurrentTxnStartOffset  int64                = 0                      [0x0034, 8B]   The current transaction start offset of the producer.
    |       |       |       +-- tagged_fields          uvarint              = 0                      [0x003c, 1B]   number of tagged fields in this struct
    |       |       +-- tagged_fields                  uvarint              = 0                      [0x003d, 1B]   number of tagged fields in this struct
    |       +-- tagged_fields                          uvarint              = 0                      [0x003e, 1B]   number of tagged fields in this struct
    +-- tagged_fields                                  uvarint              = 0                      [0x003f, 1B]   number of tagged fields in this struct

kafka message schema (.json)

{
  "apiKey": 61,
  "type": "response",
  "name": "DescribeProducersResponse",
  "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": "Topics", "type": "[]TopicResponse", "versions": "0+",
      "about": "Each topic in the response.", "fields": [
      { "name": "Name", "type": "string", "versions": "0+", "entityType": "topicName",
        "about": "The topic name." },
      { "name": "Partitions", "type": "[]PartitionResponse", "versions": "0+",
        "about": "Each partition in the response.", "fields": [
        { "name": "PartitionIndex", "type": "int32", "versions": "0+",
          "about": "The partition index." },
        { "name": "ErrorCode", "type": "int16", "versions": "0+",
          "about": "The partition error code, or 0 if there was no error." },
        { "name": "ErrorMessage", "type": "string", "versions": "0+", "nullableVersions": "0+", "default": "null",
          "about": "The partition error message, which may be null if no additional details are available." },
        { "name": "ActiveProducers", "type": "[]ProducerState", "versions": "0+",
          "about": "The active producers for the partition.", "fields": [
          { "name": "ProducerId", "type": "int64", "versions": "0+", "entityType": "producerId",
            "about": "The producer id."},
          { "name": "ProducerEpoch", "type": "int32", "versions": "0+",
            "about": "The producer epoch."},
          { "name": "LastSequence", "type": "int32", "versions": "0+", "default":  "-1",
            "about": "The last sequence number sent by the producer."},
          { "name": "LastTimestamp", "type": "int64", "versions": "0+", "default": "-1",
            "about": "The last timestamp sent by the producer."},
          { "name": "CoordinatorEpoch", "type":  "int32", "versions":  "0+",
            "about": "The current epoch of the producer group."},
          { "name": "CurrentTxnStartOffset", "type": "int64", "versions": "0+", "default": "-1",
            "about": "The current transaction start offset of the producer."}
        ]}
      ]}
    ]}
  ]
}