Service:_Kafka

Create Kafka quota

post/project/{project}/service/{service_name}/quota

Request

  • Base URL
    https://api.aiven.io/v1
  • URL
    https://api.aiven.io/v1/project/{project}/service/{service_name}/quota
  • Auth
    HTTP bearer and OAuth 2
    Authorization code: https://console.aiven.io/oauth/authorize
    Token URL: https://api.aiven.io/v1/oauth2/token scopes: services:write

Path parameters

projectstring required

Project name

service_namestring required

Service name

Request body

client\-idstring

Represents a logical group of clients, assigned a unique name by the client application. Quotas can be applied based on user, client-id, or both. The most relevant quota is chosen for each connection. All connections within a quota group share the same quota.

consumer_byte_ratenumber

Defines the bandwidth limit in bytes/sec for each group of clients sharing a quota. Every distinct client group is allocated a specific quota, as defined by the cluster, on a per-broker basis. Exceeding this limit results in client throttling.

producer_byte_ratenumber

Defines the bandwidth limit in bytes/sec for each group of clients sharing a quota. Every distinct client group is allocated a specific quota, as defined by the cluster, on a per-broker basis. Exceeding this limit results in client throttling.

request_percentagenumber

Sets the maximum percentage of CPU time that a client group can use on request handler I/O and network threads per broker within a quota window. Exceeding this limit triggers throttling. The quota, expressed as a percentage, also indicates the total allowable CPU usage for the client groups sharing the quota.

userstring

Represents a logical group of clients, assigned a unique name by the client application. Quotas can be applied based on user, client-id, or both. The most relevant quota is chosen for each connection. All connections within a quota group share the same quota.

Response

Response

messagestring

Printable result of the request

Changes

No recorded changes to this operation across all 45 revisions of this API.