Querying a Topic Quota
Function
This API is used to query a topic-level quota task.
URI
GET /v2/kafka/{project_id}/instances/{instance_id}/kafka-topic-quota
| 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 | Definition: Project ID. For details, see Obtaining a Project ID. Constraints: N/A Range: N/A Default Value: N/A |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| type | No | String | Definition: Query type. Constraints: A query type must start with a letter and can only contain letters, hyphens (-), underscores (_), and digits. Range: The default value is topic. Default Value: topic |
| limit | No | String | Definition: Number of quotas displayed on each page. Constraints: N/A Range: N/A Default Value: N/A |
| offset | No | String | Definition: Number of pages. Constraints: N/A Range: N/A Default Value: N/A |
| keyword | No | String | Definition: Query keyword. Constraints: A query keyword must start with a letter and can only contain letters, hyphens (-), underscores (_), and digits. Range: N/A Default Value: N/A |
Request Parameters
None
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| quotas | Array of KafkaTopicQuota objects | Topic quota configuration. |
| count | Integer | Number of topic quotas. |
Example Requests
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 Example Responses
Status code: 200
Topic quota queried.
{
"quotas" : [ {
"topic" : "topic-001",
"producer-byte-rate" : 1024,
"consumer-byte-rate" : 2048
} ],
"count" : 1
} Status Codes
| Status Code | Description |
|---|---|
| 200 | Topic quota queried. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot