Consulta de metadatos de clúster de Kafka
Función
Esta API se utiliza para consultar metadatos del clúster de Kafka.
URI
GET /v2/{project_id}/instances/{instance_id}/management/cluster
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
project_id |
Sí |
String |
ID del proyecto. |
instance_id |
Sí |
String |
ID de instancia. |
Parámetros de solicitud
Ninguno
Parámetros de respuesta
Código de estado: 200
Parámetro |
Tipo |
Descripción |
---|---|---|
cluster |
objeto de cluster |
Información básica del clúster. |
Parámetro |
Tipo |
Descripción |
---|---|---|
controller |
String |
ID del controlador: |
brokers |
Matriz de objetos de brokers |
Lista de agentes. |
topics_count |
Integer |
Número de temas. |
partitions_count |
Integer |
Número de particiones. |
online_partitions_count |
Integer |
Número de particiones en línea. |
replicas_count |
Integer |
Número de réplicas. |
isr_replicas_count |
Integer |
Número total de réplicas sincronizadas (ISR). |
consumers_count |
Integer |
Número de grupos de consumidores. |
Parámetro |
Tipo |
Descripción |
---|---|---|
host |
String |
Dirección IP del agente. |
port |
Integer |
Número de puerto. |
broker_id |
String |
ID del agente. |
is_controller |
Boolean |
Si el agente es un controlador. |
version |
String |
Versión del servidor. |
register_time |
Long |
Tiempo de registro del agente, que es una marca de tiempo de Unix. |
is_health |
Boolean |
Si los agentes de Kafka pueden ser conectados. |
Solicitudes de ejemplo
GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/management/cluster
Respuestas de ejemplo
Código de estado: 200
Los metadatos del clúster de Kafka se consultan correctamente.
{ "cluster" : { "controller" : "2", "brokers" : [ { "host" : "192.168.0.159", "port" : 9093, "broker_id" : "0", "is_controller" : false, "version" : "1.1.0", "register_time" : 1588754647872, "is_health" : true }, { "host" : "192.168.0.48", "port" : 9093, "broker_id" : "1", "is_controller" : false, "version" : "1.1.0", "register_time" : 1588754647653, "is_health" : true }, { "host" : "192.168.0.212", "port" : 9093, "broker_id" : "2", "is_controller" : true, "version" : "1.1.0", "register_time" : 1588754647284, "is_health" : true } ], "topics_count" : 3, "partitions_count" : 9, "online_partitions_count" : 9, "replicas_count" : 27, "isr_replicas_count" : 27, "consumers_count" : 0 } }
Códigos de estado
Código de estado |
Descripción |
---|---|
200 |
Los metadatos del clúster de Kafka se consultan correctamente. |
Códigos de error
Consulte Códigos de error.