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

Kafka AlterClientQuotas Request Wire Format v1 — Binary Protocol Layout

What is AlterClientQuotas?

Sets per-user or per-client-id throughput quotas via kafka-configs.sh --alter --entity-type. Quotas are enforced per broker and can be scoped to user level, client-id level, or their intersection. A missing entry means the default quota applies (unlimited if not configured).

Wire Diagram

Request Header · flexible
message_size int32 · 4B
api_key int16 · 2B
api_version int16 · 2B
correlation_id int32 · 4B
client_id string (compact)
tagged var
AlterClientQuotasRequest v1
Entries array
ValidateOnly bool · 1B
tagged var
Entity array
Ops array
tagged var
EntityType string (compact)
EntityName? string (compact)
tagged var
Key string (compact)
Value float64 · 8B
Remove bool · 1B
tagged var

Schema & Example

Schema
{
  "Entries": [{
      "Entity": [{
          "EntityType": string,
          "EntityName": string?
      }],
      "Ops": [{
          "Key": string,
          "Value": float64,
          "Remove": bool
      }]
  }],
  "ValidateOnly": bool
}
Example
{
  "Entries": [{
      "Entity": [{
          "EntityType": "client-id",
          "EntityName": null
      }],
      "Ops": [{
          "Key": "retention.ms",
          "Value": 0.0,
          "Remove": true
      }]
  }],
  "ValidateOnly": true
}