Querying the Current Producer List of a Topic¶

Function¶

This API is used to query the current producer list of a topic.

URI¶

GET /v2/{project_id}/kafka/instances/{instance_id}/topics/{topic}/producers

**Table 1** Path Parameters¶
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain it, see Obtaining a Project ID.
instance_id	Yes	String	Instance ID.
topic	Yes	String	Topic.

**Table 2** Query Parameters¶
Parameter	Mandatory	Type	Description
offset	No	Integer	Offset. The records after this offset will be queried.
limit	No	Integer	Maximum number of records that can be returned.

Request Parameters¶

None

Response Parameters¶

Status code: 200

**Table 3** Response body parameters¶
Parameter	Type	Description
total	Integer	Total records.
producers	Array of producers objects	Producer list.

**Table 4** producers¶
Parameter	Type	Description
producer_address	String	Producer address.
broker_address	String	Broker address.
join_time	Long	Time when the broker was connected.

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.

last updated: 2024-09-07 00:11