m manifester.io
All Kafka APIs

EndTxn

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

Request

EndTxnRequest v5, 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

EndTxnRequest                message v5                                [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            = 26 (EndTxn)            [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
+-- EndTxnRequest            struct                                    [0x000f, 13B]  message body, version 5
    +-- TransactionalId      string           = "" (compact, len+1=1)  [0x000f, 1B]   The ID of the transaction to end.
    +-- ProducerId           int64            = 0                      [0x0010, 8B]   The producer ID.
    +-- ProducerEpoch        int16            = 0                      [0x0018, 2B]   The current epoch associated with the producer.
    +-- Committed            bool             = false                  [0x001a, 1B]   True if the transaction was committed, false if it was aborted.
    +-- tagged_fields        uvarint          = 0                      [0x001b, 1B]   number of tagged fields in this struct

kafka message schema (.json)

{
  "apiKey": 26,
  "type": "request",
  "listeners": ["broker"],
  "name": "EndTxnRequest",
  // Version 1 is the same as version 0.
  //
  // Version 2 adds the support for new error code PRODUCER_FENCED.
  //
  // Version 3 enables flexible versions.
  //
  // Version 4 adds support for new error code TRANSACTION_ABORTABLE (KIP-890).
  //
  // Version 5 enables bumping epoch on every transaction (KIP-890 Part 2)
  "latestVersionUnstable": false,
  "validVersions": "0-5",
  "flexibleVersions": "3+",
  "fields": [
    { "name": "TransactionalId", "type": "string", "versions": "0+", "entityType": "transactionalId",
      "about": "The ID of the transaction to end." },
    { "name": "ProducerId", "type": "int64", "versions": "0+", "entityType": "producerId",
      "about": "The producer ID." },
    { "name": "ProducerEpoch", "type": "int16", "versions": "0+",
      "about": "The current epoch associated with the producer." },
    { "name": "Committed", "type": "bool", "versions": "0+",
      "about": "True if the transaction was committed, false if it was aborted." }
  ]
}

Response

EndTxnResponse v5, response header v1, 26 bytes on the wire

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

EndTxnResponse          message v5        [0x0000, 26B]
+-- Frame                                 [0x0000, 4B]   length-delimited framing
|   +-- size            int32       = 22  [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
+-- EndTxnResponse      struct            [0x0009, 17B]  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.
    +-- ProducerId      int64       = 0   [0x000f, 8B]   The producer ID.
    +-- ProducerEpoch   int16       = 0   [0x0017, 2B]   The current epoch associated with the producer.
    +-- tagged_fields   uvarint     = 0   [0x0019, 1B]   number of tagged fields in this struct

kafka message schema (.json)

{
  "apiKey": 26,
  "type": "response",
  "name": "EndTxnResponse",
  // Starting in version 1, on quota violation, brokers send out responses before throttling.
  //
  // Version 2 adds the support for new error code PRODUCER_FENCED.
  //
  // Version 3 enables flexible versions.
  //
  // Version 4 adds support for new error code TRANSACTION_ABORTABLE (KIP-890).
  //
  // Version 5 enables bumping epoch on every transaction (KIP-890 Part 2), so producer ID and epoch are included in the response.
  "validVersions": "0-5",
  "flexibleVersions": "3+",
  "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 error code, or 0 if there was no error." },
    { "name": "ProducerId", "type": "int64", "versions": "5+", "entityType": "producerId", "default": "-1", "ignorable": true,
      "about": "The producer ID." },
    { "name": "ProducerEpoch", "type": "int16", "versions": "5+", "default": "-1", "ignorable": true,
      "about": "The current epoch associated with the producer." }
  ]
}