Querying a Topic Quota

This API is used to query a topic-level quota task.

GET /v2/kafka/{project_id}/instances/{instance_id}/kafka-topic-quota

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
instance_id	Yes	String	Definition: Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body. Constraints: N/A Range: N/A Default Value: N/A
project_id	Yes	String	Parameter description: Project ID. For details, see Obtaining a Project ID. Constraints: N/A Value range: N/A Default value: N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
type	No	String	Parameter description: Query type. Constraints: A query type must start with a letter and can only contain letters, hyphens (-), underscores (_), and digits. Value range: The default value is topic. Default value: topic
limit	No	String	Parameter description: Number of quotas displayed on each page. Constraints: N/A Value range: N/A Default value: N/A
offset	No	String	Parameter description: Number of pages. Constraints: N/A Value range: N/A Default value: N/A
keyword	No	String	Parameter description: Query keyword. Constraints: A query keyword must start with a letter and can only contain letters, hyphens (-), underscores (_), and digits. Value range: N/A Default value: N/A

None

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
quotas	Array of KafkaTopicQuota objects	Topic quota configuration.
count	Integer	Number of topic quotas.

Querying a topic quota

GET https://{endpoint}/v2/{engine}/{project_d}/instances/{instance_id}/kafka-user-client-quota?type=topic&offset=0&limit=10&keyword=topic-02

Status code: 200

Topic quota queried.

{
  "quotas" : [ {
    "topic" : "topic-001",
    "producer-byte-rate" : 1024,
    "consumer-byte-rate" : 2048
  } ],
  "count" : 1
}

Status Code	Description
200	Topic quota queried.

Parent topic: Topic Management

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.