Help Center> Distributed Message Service for Kafka> API Reference> Out-of-Date APIs> API V1> APIs for Using Instances> Querying Controller Details for All Consumer Groups of a Kafka Instance
View PDF

Querying Controller Details for All Consumer Groups of a Kafka Instance

This API is out-of-date and may not be maintained in the future. Please use the API described in Querying Coordinator Details of a Kafka Instance.

URI

GET /v1.0/{project_id}/instances/{instance_id}/manage/coordinators

The following table describes the parameters.

Table 1 Parameters

Parameter

Type

Mandatory

Description

project_id

String

Yes

Project ID.

instance_id

String

Yes

Instance ID.

Request

Request parameters

None.

Example request

None.

Response

Response parameters

Table 2 describes the response parameters.

Table 2 Parameter

Parameter

Type

Description

coordinators

Array

List of coordinators of all consumer groups. For details, see Table 3.
Table 3 coordinators parameters

Parameter

Type

Description

group_id

String

Consumer group ID

id

Integer

Broker ID of the coordinator.

host

String

Broker address of the coordinator.

port

Integer

Port number.

Example response

{
    "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 Code

Table 4 describes the status code of successful operations. For details about other status codes, see Table 1.

Table 4 Status code

Status Code

Description

200

Controllers queried successfully.
Parent topic: APIs for Using Instances