Querying the Current Producer List of a Topic
Function
This API is used to query the current producer list of a topic.
Calling Method
For details, see Calling APIs.
URI
GET /v2/{project_id}/kafka/instances/{instance_id}/topics/{topic}/producers
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Definition: Project ID. For details, see Obtaining a Project ID. Constraints: N/A Range: N/A Default Value: N/A |
| 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 |
| topic | Yes | String | Definition: Topic. Constraints: N/A Range: N/A Default Value: N/A |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| offset | No | Integer | Definition: Offset. The records after this offset will be queried. Constraints: N/A Range: ≥ 0 Default Value: N/A |
| limit | No | Integer | Definition: Maximum number of records that can be returned. Constraints: N/A Range: 1–50 Default Value: N/A |
Request Parameters
None
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| total | Integer | Definition: Total number of records. Range: 0–10,000 |
| producers | Array of producers objects | Definition: Producer list. |
Example Requests
Querying the current producer list of a topic
GET https://{endpoint}/v2/{project_id}/kafka/instances/{instance_id}/topics/{topic}/producers?offset=0&limit=10 Example Responses
Status code: 200
The current producer list of the topic is queried successfully.
{
"total" : 3,
"producers" : [ {
"producer_address" : "192.0.0.149:40443",
"broker_address" : "192.0.0.146:9092",
"join_time" : 1687204743328
}, {
"producer_address" : "192.0.0.149:13807",
"broker_address" : "192.0.0.80:9092",
"join_time" : 1687204745939
}, {
"producer_address" : "192.0.0.149:31876",
"broker_address" : "192.0.0.71:9092",
"join_time" : 1687204744934
} ]
} Status Codes
| Status Code | Description |
|---|---|
| 200 | The current producer list of the topic is queried successfully. |
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.
