DescribeConfigs
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 4 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
- 32
- Encoded at
- v4
- Flexible versions
- 4+
- Headers
- req v2, resp v1
- Request versions
- 1-4
- Response versions
- 1-4
- Request size
- 24 bytes
- Response size
- 35 bytes
framerpc headerrequest bodyRecordBatchRecordresponse bodytagged_fields
Request
DescribeConfigsRequest v4, 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
DescribeConfigsRequest message v4 [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 = 32 (DescribeConfigs) [0x0004, 2B] numeric id of the API being invoked | +-- request_api_version int16 = 4 [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 +-- DescribeConfigsRequest struct [0x000f, 9B] message body, version 4 +-- Resources []DescribeConfigsResource = 1 element [0x000f, 6B] The resources whose configurations we want to describe. | +-- length uvarint = 2 (compact, n+1) [0x000f, 1B] one sample element follows | +-- DescribeConfigsResource[0] DescribeConfigsResource = struct [0x0010, 5B] | +-- ResourceType int8 = 0 [0x0010, 1B] The resource type. | +-- ResourceName string = "" (compact, len+1=1) [0x0011, 1B] The resource name. | +-- ConfigurationKeys []string = 1 element [0x0012, 2B] The configuration keys to list, or null to list all configuration keys. | | +-- length uvarint = 2 (compact, n+1) [0x0012, 1B] one sample element follows | | +-- string[0] string = "" (compact, len+1=1) [0x0013, 1B] | +-- tagged_fields uvarint = 0 [0x0014, 1B] number of tagged fields in this struct +-- IncludeSynonyms bool = false [0x0015, 1B] True if we should include all synonyms. +-- IncludeDocumentation bool = false [0x0016, 1B] True if we should include configuration documentation. +-- tagged_fields uvarint = 0 [0x0017, 1B] number of tagged fields in this struct
kafka message schema (.json)
{ "apiKey": 32, "type": "request", "listeners": ["broker", "controller"], "name": "DescribeConfigsRequest", // Version 0 was removed in Apache Kafka 4.0, Version 1 is the new baseline. // Version 1 adds IncludeSynonyms and removes IsDefault. // Version 2 is the same as version 1. // Version 4 enables flexible versions. "validVersions": "1-4", "flexibleVersions": "4+", "fields": [ { "name": "Resources", "type": "[]DescribeConfigsResource", "versions": "0+", "about": "The resources whose configurations we want to describe.", "fields": [ { "name": "ResourceType", "type": "int8", "versions": "0+", "about": "The resource type." }, { "name": "ResourceName", "type": "string", "versions": "0+", "about": "The resource name." }, { "name": "ConfigurationKeys", "type": "[]string", "versions": "0+", "nullableVersions": "0+", "about": "The configuration keys to list, or null to list all configuration keys." } ]}, { "name": "IncludeSynonyms", "type": "bool", "versions": "1+", "default": "false", "ignorable": false, "about": "True if we should include all synonyms." }, { "name": "IncludeDocumentation", "type": "bool", "versions": "3+", "default": "false", "ignorable": false, "about": "True if we should include configuration documentation." } ] }
Response
DescribeConfigsResponse v4, response header v1, 35 bytes on the wire
byte layout (35 bytes, 16 bytes per row)
0
1
2
3
4
5
6
7
8
9
A
B
C
D
E
F
0000
0010
0020
object tree
DescribeConfigsResponse message v4 [0x0000, 35B] +-- Frame [0x0000, 4B] length-delimited framing | +-- size int32 = 31 [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 +-- DescribeConfigsResponse struct [0x0009, 26B] message body, version 4 +-- ThrottleTimeMs int32 = 0 [0x0009, 4B] The duration in milliseconds for which the request was throttled due to a q... +-- Results []DescribeConfigsResult = 1 element [0x000d, 21B] The results for each resource. | +-- length uvarint = 2 (compact, n+1) [0x000d, 1B] one sample element follows | +-- DescribeConfigsResult[0] DescribeConfigsResult = struct [0x000e, 20B] | +-- ErrorCode int16 = 0 [0x000e, 2B] The error code, or 0 if we were able to successfully describe the configura... | +-- ErrorMessage string = "" (compact, len+1=1) [0x0010, 1B] The error message, or null if we were able to successfully describe the con... | +-- ResourceType int8 = 0 [0x0011, 1B] The resource type. | +-- ResourceName string = "" (compact, len+1=1) [0x0012, 1B] The resource name. | +-- Configs []DescribeConfigsResourceResult = 1 element [0x0013, 14B] Each listed configuration. | | +-- length uvarint = 2 (compact, n+1) [0x0013, 1B] one sample element follows | | +-- DescribeConfigsResourceResult[0] DescribeConfigsResourceResult = struct [0x0014, 13B] | | +-- Name string = "" (compact, len+1=1) [0x0014, 1B] The configuration name. | | +-- Value string = "" (compact, len+1=1) [0x0015, 1B] The configuration value. | | +-- ReadOnly bool = false [0x0016, 1B] True if the configuration is read-only. | | +-- ConfigSource int8 = 0 [0x0017, 1B] The configuration source. | | +-- IsSensitive bool = false [0x0018, 1B] True if this configuration is sensitive. | | +-- Synonyms []DescribeConfigsSynonym = 1 element [0x0019, 5B] The synonyms for this configuration key. | | | +-- length uvarint = 2 (compact, n+1) [0x0019, 1B] one sample element follows | | | +-- DescribeConfigsSynonym[0] DescribeConfigsSynonym = struct [0x001a, 4B] | | | +-- Name string = "" (compact, len+1=1) [0x001a, 1B] The synonym name. | | | +-- Value string = "" (compact, len+1=1) [0x001b, 1B] The synonym value. | | | +-- Source int8 = 0 [0x001c, 1B] The synonym source. | | | +-- tagged_fields uvarint = 0 [0x001d, 1B] number of tagged fields in this struct | | +-- ConfigType int8 = 0 [0x001e, 1B] The configuration data type. Type can be one of the following values - BOOL... | | +-- Documentation string = "" (compact, len+1=1) [0x001f, 1B] The configuration documentation. | | +-- tagged_fields uvarint = 0 [0x0020, 1B] number of tagged fields in this struct | +-- tagged_fields uvarint = 0 [0x0021, 1B] number of tagged fields in this struct +-- tagged_fields uvarint = 0 [0x0022, 1B] number of tagged fields in this struct
kafka message schema (.json)
{ "apiKey": 32, "type": "response", "name": "DescribeConfigsResponse", // Version 0 was removed in Apache Kafka 4.0, Version 1 is the new baseline. // Version 1 adds ConfigSource and the synonyms. // Starting in version 2, on quota violation, brokers send out responses before throttling. // Version 4 enables flexible versions. "validVersions": "1-4", "flexibleVersions": "4+", "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": "Results", "type": "[]DescribeConfigsResult", "versions": "0+", "about": "The results for each resource.", "fields": [ { "name": "ErrorCode", "type": "int16", "versions": "0+", "about": "The error code, or 0 if we were able to successfully describe the configurations." }, { "name": "ErrorMessage", "type": "string", "versions": "0+", "nullableVersions": "0+", "about": "The error message, or null if we were able to successfully describe the configurations." }, { "name": "ResourceType", "type": "int8", "versions": "0+", "about": "The resource type." }, { "name": "ResourceName", "type": "string", "versions": "0+", "about": "The resource name." }, { "name": "Configs", "type": "[]DescribeConfigsResourceResult", "versions": "0+", "about": "Each listed configuration.", "fields": [ { "name": "Name", "type": "string", "versions": "0+", "about": "The configuration name." }, { "name": "Value", "type": "string", "versions": "0+", "nullableVersions": "0+", "about": "The configuration value." }, { "name": "ReadOnly", "type": "bool", "versions": "0+", "about": "True if the configuration is read-only." }, { "name": "ConfigSource", "type": "int8", "versions": "1+", "default": "-1", "ignorable": true, "about": "The configuration source." }, { "name": "IsSensitive", "type": "bool", "versions": "0+", "about": "True if this configuration is sensitive." }, { "name": "Synonyms", "type": "[]DescribeConfigsSynonym", "versions": "1+", "ignorable": true, "about": "The synonyms for this configuration key.", "fields": [ { "name": "Name", "type": "string", "versions": "1+", "about": "The synonym name." }, { "name": "Value", "type": "string", "versions": "1+", "nullableVersions": "0+", "about": "The synonym value." }, { "name": "Source", "type": "int8", "versions": "1+", "about": "The synonym source." } ]}, { "name": "ConfigType", "type": "int8", "versions": "3+", "default": "0", "ignorable": true, "about": "The configuration data type. Type can be one of the following values - BOOLEAN, STRING, INT, SHORT, LONG, DOUBLE, LIST, CLASS, PASSWORD." }, { "name": "Documentation", "type": "string", "versions": "3+", "nullableVersions": "0+", "ignorable": true, "about": "The configuration documentation." } ]} ]} ] }