DescribeClientQuotas
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 1 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
- 48
- Encoded at
- v1
- Flexible versions
- 1+
- Headers
- req v2, resp v1
- Request versions
- 0-1
- Response versions
- 0-1
- Request size
- 22 bytes
- Response size
- 34 bytes
framerpc headerrequest bodyRecordBatchRecordresponse bodytagged_fields
Request
DescribeClientQuotasRequest v1, request header v2, 22 bytes on the wire
byte layout (22 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
DescribeClientQuotasRequest message v1 [0x0000, 22B] +-- Frame [0x0000, 4B] length-delimited framing | +-- size int32 = 18 [0x0000, 4B] number of bytes that follow, patched after encoding +-- RequestHeader v2 [0x0004, 11B] common request header | +-- request_api_key int16 = 48 (DescribeClientQuotas) [0x0004, 2B] numeric id of the API being invoked | +-- request_api_version int16 = 1 [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 +-- DescribeClientQuotasRequest struct [0x000f, 7B] message body, version 1 +-- Components []ComponentData = 1 element [0x000f, 5B] Filter components to apply to quota entities. | +-- length uvarint = 2 (compact, n+1) [0x000f, 1B] one sample element follows | +-- ComponentData[0] ComponentData = struct [0x0010, 4B] | +-- EntityType string = "" (compact, len+1=1) [0x0010, 1B] The entity type that the filter component applies to. | +-- MatchType int8 = 0 [0x0011, 1B] How to match the entity {0 = exact name, 1 = default name, 2 = any specifie... | +-- Match string = "" (compact, len+1=1) [0x0012, 1B] The string to match against, or null if unused for the match type. | +-- tagged_fields uvarint = 0 [0x0013, 1B] number of tagged fields in this struct +-- Strict bool = false [0x0014, 1B] Whether the match is strict, i.e. should exclude entities with unspecified ... +-- tagged_fields uvarint = 0 [0x0015, 1B] number of tagged fields in this struct
kafka message schema (.json)
{ "apiKey": 48, "type": "request", "listeners": ["broker"], "name": "DescribeClientQuotasRequest", // Version 1 enables flexible versions. "validVersions": "0-1", "flexibleVersions": "1+", "fields": [ { "name": "Components", "type": "[]ComponentData", "versions": "0+", "about": "Filter components to apply to quota entities.", "fields": [ { "name": "EntityType", "type": "string", "versions": "0+", "about": "The entity type that the filter component applies to." }, { "name": "MatchType", "type": "int8", "versions": "0+", "about": "How to match the entity {0 = exact name, 1 = default name, 2 = any specified name}." }, { "name": "Match", "type": "string", "versions": "0+", "nullableVersions": "0+", "about": "The string to match against, or null if unused for the match type." } ]}, { "name": "Strict", "type": "bool", "versions": "0+", "about": "Whether the match is strict, i.e. should exclude entities with unspecified entity types." } ] }
Response
DescribeClientQuotasResponse v1, response header v1, 34 bytes on the wire
byte layout (34 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
DescribeClientQuotasResponse message v1 [0x0000, 34B] +-- Frame [0x0000, 4B] length-delimited framing | +-- size int32 = 30 [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 +-- DescribeClientQuotasResponse struct [0x0009, 25B] message body, version 1 +-- 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 the quota description succeeded. +-- ErrorMessage string = "" (compact, len+1=1) [0x000f, 1B] The error message, or `null` if the quota description succeeded. +-- Entries []EntryData = 1 element [0x0010, 17B] A result entry. | +-- length uvarint = 2 (compact, n+1) [0x0010, 1B] one sample element follows | +-- EntryData[0] EntryData = struct [0x0011, 16B] | +-- Entity []EntityData = 1 element [0x0011, 4B] The quota entity description. | | +-- length uvarint = 2 (compact, n+1) [0x0011, 1B] one sample element follows | | +-- EntityData[0] EntityData = struct [0x0012, 3B] | | +-- EntityType string = "" (compact, len+1=1) [0x0012, 1B] The entity type. | | +-- EntityName string = "" (compact, len+1=1) [0x0013, 1B] The entity name, or null if the default. | | +-- tagged_fields uvarint = 0 [0x0014, 1B] number of tagged fields in this struct | +-- Values []ValueData = 1 element [0x0015, 11B] The quota values for the entity. | | +-- length uvarint = 2 (compact, n+1) [0x0015, 1B] one sample element follows | | +-- ValueData[0] ValueData = struct [0x0016, 10B] | | +-- Key string = "" (compact, len+1=1) [0x0016, 1B] The quota configuration key. | | +-- Value float64 = 0 [0x0017, 8B] The quota configuration value. | | +-- tagged_fields uvarint = 0 [0x001f, 1B] number of tagged fields in this struct | +-- 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
kafka message schema (.json)
{ "apiKey": 48, "type": "response", "name": "DescribeClientQuotasResponse", // Version 1 enables flexible versions. "validVersions": "0-1", "flexibleVersions": "1+", "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 the quota description succeeded." }, { "name": "ErrorMessage", "type": "string", "versions": "0+", "nullableVersions": "0+", "about": "The error message, or `null` if the quota description succeeded." }, { "name": "Entries", "type": "[]EntryData", "versions": "0+", "nullableVersions": "0+", "about": "A result entry.", "fields": [ { "name": "Entity", "type": "[]EntityData", "versions": "0+", "about": "The quota entity description.", "fields": [ { "name": "EntityType", "type": "string", "versions": "0+", "about": "The entity type." }, { "name": "EntityName", "type": "string", "versions": "0+", "nullableVersions": "0+", "about": "The entity name, or null if the default." } ]}, { "name": "Values", "type": "[]ValueData", "versions": "0+", "about": "The quota values for the entity.", "fields": [ { "name": "Key", "type": "string", "versions": "0+", "about": "The quota configuration key." }, { "name": "Value", "type": "float64", "versions": "0+", "about": "The quota configuration value." } ]} ]} ] }