Kafka Configs Kafka Protocol Wire Format API Versions KIPs Errors Kafka Upgrade Config Advisor Flink SQL
conduktor.io ↗

Kafka DescribeClientQuotas Response Wire Format v1 — Binary Protocol Layout

What is DescribeClientQuotas?

Returns per-user or per-client-id throttle limits via kafka-configs.sh --describe --entity-type users/clients. Check this first when a client reports being throttled unexpectedly.

Related Errors

CLUSTER_AUTHORIZATION_FAILED

Wire Diagram

Response Header · flexible
message_size int32 · 4B
correlation_id int32 · 4B
tagged var
DescribeClientQuotasResponse v1
ThrottleTimeMs int32 · 4B
ErrorCode int16 · 2B
ErrorMessage? string (compact)
Entries? array
tagged var
Entity array
Values array
tagged var
EntityType string (compact)
EntityName? string (compact)
tagged var
Key string (compact)
Value float64 · 8B
tagged var

Schema & Example

Schema
{
  "ThrottleTimeMs": int32,
  "ErrorCode": int16,
  "ErrorMessage": string?,
  "Entries": [{
      "Entity": [{
          "EntityType": string,
          "EntityName": string?
      }],
      "Values": [{
          "Key": string,
          "Value": float64
      }]
  }]?
}
Example
{
  "ThrottleTimeMs": 0,
  "ErrorCode": 0,
  "ErrorMessage": "NETWORK_EXCEPTION",
  "Entries": [{
      "Entity": [{
          "EntityType": "client-id",
          "EntityName": "orders"
      }],
      "Values": [{
          "Key": "retention.ms",
          "Value": 0.0
      }]
  }]?
}