m manifester.io
All Kafka APIs

RenewDelegationToken

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
39
Encoded at
v2
Flexible versions
2+
Headers
req v2, resp v1
Request versions
1-2
Response versions
1-2
Request size
25 bytes
Response size
24 bytes
framerpc headerrequest bodyRecordBatchRecordresponse bodytagged_fields

Request

RenewDelegationTokenRequest 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

RenewDelegationTokenRequest      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            = 39 (RenewDelegationToken)  [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
+-- RenewDelegationTokenRequest  struct                                        [0x000f, 10B]  message body, version 2
    +-- Hmac                     bytes            = empty (compact, len+1=1)   [0x000f, 1B]   The HMAC of the delegation token to be renewed.
    +-- RenewPeriodMs            int64            = 0                          [0x0010, 8B]   The renewal time period in milliseconds.
    +-- tagged_fields            uvarint          = 0                          [0x0018, 1B]   number of tagged fields in this struct

kafka message schema (.json)

{
  "apiKey": 39,
  "type": "request",
  "listeners": ["broker", "controller"],
  "name": "RenewDelegationTokenRequest",
  // Version 0 was removed in Apache Kafka 4.0, Version 1 is the new baseline.
  // Version 1 is the same as version 0.
  // Version 2 adds flexible version support
  "validVersions": "1-2",
  "flexibleVersions": "2+",
  "fields": [
    { "name": "Hmac", "type": "bytes", "versions": "0+",
      "about": "The HMAC of the delegation token to be renewed." },
    { "name": "RenewPeriodMs", "type": "int64", "versions": "0+",
      "about": "The renewal time period in milliseconds." }
  ]
}

Response

RenewDelegationTokenResponse v2, response header v1, 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

RenewDelegationTokenResponse      message v2        [0x0000, 24B]
+-- Frame                                           [0x0000, 4B]   length-delimited framing
|   +-- size                      int32       = 20  [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
+-- RenewDelegationTokenResponse  struct            [0x0009, 15B]  message body, version 2
    +-- ErrorCode                 int16       = 0   [0x0009, 2B]   The error code, or 0 if there was no error.
    +-- ExpiryTimestampMs         int64       = 0   [0x000b, 8B]   The timestamp in milliseconds at which this token expires.
    +-- ThrottleTimeMs            int32       = 0   [0x0013, 4B]   The duration in milliseconds for which the request was throttled due to a q...
    +-- tagged_fields             uvarint     = 0   [0x0017, 1B]   number of tagged fields in this struct

kafka message schema (.json)

{
  "apiKey": 39,
  "type": "response",
  "name": "RenewDelegationTokenResponse",
  // Version 0 was removed in Apache Kafka 4.0, Version 1 is the new baseline.
  // Starting in version 1, on quota violation, brokers send out responses before throttling.
  // Version 2 adds flexible version support
  "validVersions": "1-2",
  "flexibleVersions": "2+",
  "fields": [
    { "name": "ErrorCode", "type": "int16", "versions": "0+",
      "about": "The error code, or 0 if there was no error." },
    { "name": "ExpiryTimestampMs", "type": "int64", "versions": "0+",
      "about": "The timestamp in milliseconds at which this token expires." },
    { "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." }
  ]
}