Creating User or Client Quotas

Function

This API is used to submit a task to create user or client quotas for a Kafka instance. A job_id is returned if the task succeeds.

URI

POST /v2/kafka/{project_id}/instances/{instance_id}/kafka-user-client-quota

Table 1 Path Parameters
Parameter	Mandatory	Type	Description
instance_id	Yes	String	Instance ID.
project_id	Yes	String	Project ID. For details, see Obtaining a Project ID.

Request Parameters

Table 2 Request body parameters
Parameter	Mandatory	Type	Description
user	No	String	Username. Either the username or the client ID must be specified if the quotas are not applied to all users or clients.
client	No	String	Client ID. Either the username or the client ID must be specified if the quotas are not applied to all users or clients.
user-default	No	Boolean	Indicates whether to use the default user settings. Yes: Apply the quota to all users. In this case, the username cannot be set. No: Apply the quota to specific users. In this case, set the username.
client-default	No	Boolean	Indicates whether to use the default client settings. Yes: Apply the quota to all clients. In this case, the client ID cannot be set. No: Apply the quota to specific clients. In this case, set the client ID.
producer-byte-rate	No	Long	Production rate limit. The unit is byte/s.
consumer-byte-rate	No	Long	Consumption rate limit. The unit is byte/s. NOTE: Either the production rate limit or the consumption rate limit must be specified.

Response Parameters

Status code: 200

Table 3 Response body parameters
Parameter	Type	Description
job_id	String	ID of the task for creating quotas.

Example Requests

Creating user or client quotas

POST https://{endpoint}/v2/kafka/{project_id}/instances/{instance_id}/kafka-user-client-quota

{
  "user" : "",
  "client" : "",
  "user-default" : false,
  "client-default" : true,
  "producer-byte-rate" : 3145728,
  "consumer-byte-rate" : 2097152
}

Example Responses

Status code: 200

User or client quotas created.

{
  "job_id" : "ff8080828bdc0f64018bdcadfd8f00d7"
}

Status Codes

Status Code	Description
200	User or client quotas created.

Error Codes

See Error Codes.

Parent topic: Instance Management

Предыдущая статья

Querying User or Client Quotas

Следующая статья

Modifying User or Client Quotas

Была ли эта статья полезна?

Поддержка Юридические документы