Chen, Junjie ef239b7410 DMS API-REF 20230201 Version

Reviewed-by: Ziuzko, Stanislav <stanislav.ziuzko@t-systems.com>
Co-authored-by: Chen, Junjie <chenjunjie@huawei.com>
Co-committed-by: Chen, Junjie <chenjunjie@huawei.com>

2024-07-03 17:41:26 +00:00

9.8 KiB

Raw Blame History

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. Minimum: 1 Maximum: 64
instance_id	Yes	String	Instance ID. Minimum: 1 Maximum: 64
topic	Yes	String	Topic. Minimum: 1 Maximum: 200

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

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
total	Integer	Total records. Minimum: 0 Maximum: 10000
producers	Array of producers objects	Producer list. Array Length: 0 - 50

**Table 4** producers
Parameter	Type	Description
producer_address	String	Producer address. Minimum: 0 Maximum: 64
broker_address	String	Broker address. Minimum: 0 Maximum: 64
join_time	Long	Time when the broker was connected. Minimum: 0 Maximum: 9223372036854775807

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.

Parent topic: Topic Management

9.8 KiB Raw Blame History