Help Center/ Distributed Message Service for Kafka/ API Reference/ APIs V2 (Recommended)/ Instance Management/ Querying Coordinator Details of a Kafka Instance
Updated on 2026-03-16 GMT+08:00
View PDF

Querying Coordinator Details of a Kafka Instance

Function

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

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

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

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

coordinators

Array of coordinators objects

Definition:

List of coordinators of all consumer groups.
Table 3 coordinators

Parameter

Type

Description

group_id

String

Definition:

Consumer group ID.

Range:

N/A

id

Integer

Definition:

Broker ID of the coordinator.

Range:

N/A

host

String

Definition:

Broker address of the coordinator.

Range:

N/A

port

Integer

Definition:

Port.

Range:

N/A

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