Consulta de dimensiones de supervisión de instancias de Kafka
Función
Esta API se utiliza para consultar dimensiones de supervisión de instancia de Kafka.
URI
GET /v2/{project_id}/instances/{instance_id}/ces-hierarchy
Parámetro | Mandatory | Tipo | Descripción |
|---|---|---|---|
project_id | Sí | String | ID del proyecto. |
instance_id | Sí | String | ID de la instancia |
Parámetros de solicitud
No hay
Parámetros de respuesta
Código de estado: 200
Parámetro | Tipo | Descripción |
|---|---|---|
dimensions | Array of dimensions objects | Control de dimensiones. |
instance_ids | Array of instance_ids objects | información sobre instancias |
nodes | Array of nodes objects | Información del corredor. |
queues | Array of queues objects | Información sobre el tema. |
groups | Array of groups objects | Información del grupo de consumidores. |
Parámetro | Tipo | Descripción |
|---|---|---|
name | String | Controlar el nombre de la dimensión. |
metrics | Array of strings | Nombre de la métrica |
key_name | Array of strings | Clave utilizada para la consulta de supervisión. |
dim_router | Array of strings | Monitoreo de la ruta de la dimensión. |
children | Array of children objects | Lista de dimensiones secundarias. |
Parámetro | Tipo | Descripción |
|---|---|---|
name | String | Nombre de la dimensión secundaria. |
metrics | Array of strings | Métricas en la dimensión secundaria. |
key_name | Array of strings | Clave utilizada para la consulta de supervisión. |
dim_router | Array of strings | Monitoreo de la ruta de la dimensión. |
Parámetro | Tipo | Descripción |
|---|---|---|
name | String | Nombre del tema |
partitions | Array of partitions objects | Lista de particiones. |
Parámetro | Tipo | Descripción |
|---|---|---|
name | String | Nombre del grupo de consumidores |
queues | Array of queues objects | Información sobre el tema. |
Parámetro | Tipo | Descripción |
|---|---|---|
name | String | Nombre del tema |
partitions | Array of partitions objects | Información de particiones. |
Parámetro | Tipo | Descripción |
|---|---|---|
name | String | Nombre de la partición. |
Ejemplo de las solicitudes
GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/ces-hierarchy Ejemplo de las respuestas
Código de estado: 200
La información se muestra correctamente.
{
"dimensions" : [ {
"name" : "kafka_instance_id",
"metrics" : [ "current_partitions", "current_topics", "group_messages" ],
"key_name" : [ "instance_ids" ],
"dim_router" : [ "kafka_instance_id" ]
}, {
"name" : "kafka_broker",
"metrics" : [ "broker_data_size", "broker_messages_in_rate", "broker_bytes_out_rate", "broker_bytes_in_rate", "broker_produce_mean", "broker_fetch_mean" ],
"key_name" : [ "nodes" ],
"dim_router" : [ "kafka_instance_id", "kafka_broker" ]
}, {
"name" : "kafka_rest",
"metrics" : [ "rest_produce_success", "rest_produce_failed", "rest_produce_latency", "rest_produce_msg_num", "rest_produce_flow", "rest_consume_success", "rest_consume_failed", "rest_consume_latency", "rest_consume_msg_num", "rest_consume_flow", "rest_commit_success", "rest_commit_failed", "rest_commit_latency", "rest_commit_msg_num", "rest_commit_flow" ],
"key_name" : [ "nodes" ],
"dim_router" : [ "kafka_instance_id", "kafka_rest" ]
}, {
"name" : "kafka_topics",
"metrics" : [ "topic_data_size", "topic_messages_in_rate", "topic_bytes_out_rate", "topic_bytes_in_rate", "topic_messages" ],
"key_name" : [ "queues" ],
"dim_router" : [ "kafka_instance_id", "kafka_topics" ],
"children" : [ {
"name" : "kafka_partitions",
"metrics" : [ "produced_messages", "partition_messages" ],
"key_name" : [ "queues", "partitions" ],
"dim_router" : [ "kafka_instance_id", "kafka_topics", "kafka_partitions" ]
} ]
}, {
"name" : "kafka_groups_partitions",
"metrics" : [ "messages_consumed", "messages_remained" ],
"key_name" : [ "groups", "queues", "partitions" ],
"dim_router" : [ "kafka_instance_id", "kafka_groups", "kafka_groups_topics", "kafka_groups_partitions" ]
} ],
"instance_ids" : [ {
"name" : "68f3f6a0-3741-453b-bda9-a6ff6b5bb6f7"
} ],
"nodes" : [ {
"name" : "broker-0"
}, {
"name" : "broker-1"
}, {
"name" : "broker-2"
} ],
"queues" : [ {
"name" : "aaaa",
"partitions" : [ {
"name" : "0"
} ]
}, {
"name" : "mytest",
"partitions" : [ {
"name" : "0"
}, {
"name" : "1"
}, {
"name" : "2"
} ]
}, {
"name" : "topic-84234378",
"partitions" : [ {
"name" : "0"
}, {
"name" : "1"
}, {
"name" : "2"
} ]
} ],
"groups" : [ {
"name" : "test-consumer-group",
"queues" : [ {
"name" : "mytest",
"partitions" : [ {
"name" : "0"
}, {
"name" : "1"
}, {
"name" : "2"
} ]
} ]
} ]
} Códigos de estado
Código de estado | Descripción |
|---|---|
200 | La información se muestra correctamente. |
Códigos de error
Consulte Códigos de error.
