Chen, Junjie f5b629cc78 DMS API 20240722 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-09-06 09:17:23 +00:00

7.0 KiB

Raw Blame History

Querying Coordinator Details of a Kafka Instance

Function

This API is used to query coordinator details of a Kafka instance.

URI

GET /v2/{project_id}/instances/{instance_id}/management/coordinators

**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.

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
coordinators	Array of coordinators objects	List of coordinators of all consumer groups.

**Table 3** coordinators
Parameter	Type	Description
group_id	String	Consumer group ID.
id	Integer	Broker ID of the coordinator.
host	String	Address of the coordinator.
port	Integer	Port number.

Example Requests

GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/management/coordinators

Example Responses

Status code: 200

Coordinator details of the Kafka instance are queried successfully.

{
  "coordinators" : [ {
    "group_id" : "XXXX",
    "id" : 2,
    "host" : "172.31.1.15",
    "port" : 9091
  }, {
    "group_id" : "XXXX",
    "id" : 2,
    "host" : "172.31.1.15",
    "port" : 9092
  }, {
    "group_id" : "XXXX",
    "id" : 2,
    "host" : "172.31.1.15",
    "port" : 9092
  } ]
}

Status Codes

Status Code	Description
200	Coordinator details of the Kafka instance are queried successfully.

Error Codes

See Error Codes.

Parent topic: Instance Management

7.0 KiB Raw Blame History