AlterConfigs
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
- 33
- Encoded at
- v2
- Flexible versions
- 2+
- Headers
- req v2, resp v1
- Request versions
- 0-2
- Response versions
- 0-2
- Request size
- 25 bytes
- Response size
- 21 bytes
framerpc headerrequest bodyRecordBatchRecordresponse bodytagged_fields
Request
AlterConfigsRequest 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
AlterConfigsRequest 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 = 33 (AlterConfigs) [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 +-- AlterConfigsRequest struct [0x000f, 10B] message body, version 2 +-- Resources []AlterConfigsResource = 1 element [0x000f, 8B] The updates for each resource. | +-- length uvarint = 2 (compact, n+1) [0x000f, 1B] one sample element follows | +-- AlterConfigsResource[0] AlterConfigsResource = struct [0x0010, 7B] | +-- ResourceType int8 = 0 [0x0010, 1B] The resource type. | +-- ResourceName string = "" (compact, len+1=1) [0x0011, 1B] The resource name. | +-- Configs []AlterableConfig = 1 element [0x0012, 4B] The configurations. | | +-- length uvarint = 2 (compact, n+1) [0x0012, 1B] one sample element follows | | +-- AlterableConfig[0] AlterableConfig = struct [0x0013, 3B] | | +-- Name string = "" (compact, len+1=1) [0x0013, 1B] The configuration key name. | | +-- Value string = "" (compact, len+1=1) [0x0014, 1B] The value to set for the configuration key. | | +-- tagged_fields uvarint = 0 [0x0015, 1B] number of tagged fields in this struct | +-- tagged_fields uvarint = 0 [0x0016, 1B] number of tagged fields in this struct +-- ValidateOnly bool = false [0x0017, 1B] True if we should validate the request, but not change the configurations. +-- tagged_fields uvarint = 0 [0x0018, 1B] number of tagged fields in this struct
kafka message schema (.json)
{ "apiKey": 33, "type": "request", "listeners": ["broker", "controller"], "name": "AlterConfigsRequest", // Version 1 is the same as version 0. // Version 2 enables flexible versions. "validVersions": "0-2", "flexibleVersions": "2+", "fields": [ { "name": "Resources", "type": "[]AlterConfigsResource", "versions": "0+", "about": "The updates for each resource.", "fields": [ { "name": "ResourceType", "type": "int8", "versions": "0+", "mapKey": true, "about": "The resource type." }, { "name": "ResourceName", "type": "string", "versions": "0+", "mapKey": true, "about": "The resource name." }, { "name": "Configs", "type": "[]AlterableConfig", "versions": "0+", "about": "The configurations.", "fields": [ { "name": "Name", "type": "string", "versions": "0+", "mapKey": true, "about": "The configuration key name." }, { "name": "Value", "type": "string", "versions": "0+", "nullableVersions": "0+", "about": "The value to set for the configuration key."} ]} ]}, { "name": "ValidateOnly", "type": "bool", "versions": "0+", "about": "True if we should validate the request, but not change the configurations."} ] }
Response
AlterConfigsResponse v2, response header v1, 21 bytes on the wire
byte layout (21 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
AlterConfigsResponse message v2 [0x0000, 21B] +-- Frame [0x0000, 4B] length-delimited framing | +-- size int32 = 17 [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 +-- AlterConfigsResponse struct [0x0009, 12B] message body, version 2 +-- ThrottleTimeMs int32 = 0 [0x0009, 4B] Duration in milliseconds for which the request was throttled due to a quota... +-- Responses []AlterConfigsResourceResponse = 1 element [0x000d, 7B] The responses for each resource. | +-- length uvarint = 2 (compact, n+1) [0x000d, 1B] one sample element follows | +-- AlterConfigsResourceResponse[0] AlterConfigsResourceResponse = struct [0x000e, 6B] | +-- ErrorCode int16 = 0 [0x000e, 2B] The resource error code. | +-- ErrorMessage string = "" (compact, len+1=1) [0x0010, 1B] The resource error message, or null if there was no error. | +-- ResourceType int8 = 0 [0x0011, 1B] The resource type. | +-- ResourceName string = "" (compact, len+1=1) [0x0012, 1B] The resource name. | +-- tagged_fields uvarint = 0 [0x0013, 1B] number of tagged fields in this struct +-- tagged_fields uvarint = 0 [0x0014, 1B] number of tagged fields in this struct
kafka message schema (.json)
{ "apiKey": 33, "type": "response", "name": "AlterConfigsResponse", // Starting in version 1, on quota violation brokers send out responses before throttling. // Version 2 enables flexible versions. "validVersions": "0-2", "flexibleVersions": "2+", "fields": [ { "name": "ThrottleTimeMs", "type": "int32", "versions": "0+", "about": "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": "Responses", "type": "[]AlterConfigsResourceResponse", "versions": "0+", "about": "The responses for each resource.", "fields": [ { "name": "ErrorCode", "type": "int16", "versions": "0+", "about": "The resource error code." }, { "name": "ErrorMessage", "type": "string", "nullableVersions": "0+", "versions": "0+", "about": "The resource error message, or null if there was no error." }, { "name": "ResourceType", "type": "int8", "versions": "0+", "about": "The resource type." }, { "name": "ResourceName", "type": "string", "versions": "0+", "about": "The resource name." } ]} ] }