Consulta de los detalles del tema
Función
Esta API se utiliza para consultar los detalles del tema de una instancia de Kafka.
URI
GET /v2/{project_id}/instances/{instance_id}/management/topics/{topic}
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
project_id |
Sí |
String |
ID del proyecto. |
|
instance_id |
Sí |
String |
ID de la instancia |
|
topic |
Sí |
String |
Nombre del tema |
Parámetros de solicitud
No hay
Parámetros de respuesta
Código de estado: 200
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
topic |
String |
Nombre del tema |
|
partitions |
Array of partitions objects |
Lista de particiones. |
|
group_subscribed |
Array of strings |
Lista de grupos de consumidores que se suscriben al tema. |
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
partition |
Integer |
ID de partición |
|
leader |
Integer |
ID del corredor donde reside la réplica de líder. |
|
leo |
Integer |
LEO de la réplica de líder de partición. |
|
hw |
Integer |
Marca de agua alta (HW) de la partición. |
|
lso |
Integer |
Offset de inicio de registro (LSO) de la réplica de líder de partición. |
|
last_update_timestamp |
Long |
Hora en que se escribió el último mensaje en la partición. El valor es una marca de tiempo de Unix. Unidad: ms |
|
replicas |
Array of replicas objects |
Lista de réplicas. |
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
broker |
Integer |
ID del corredor donde reside la réplica. |
|
leader |
Boolean |
Si la réplica es el líder. |
|
in_sync |
Boolean |
Si la réplica está en el ISR. |
|
size |
Integer |
Tamaño actual del log de la réplica. Unidad: byte. |
|
lag |
Integer |
Número de mensajes que se retrasan por detrás de la marca de agua alta en la réplica. |
Ejemplo de las solicitudes
GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/management/topics/{topic}
Ejemplo de las respuestas
Código de estado: 200
La consulta se realiza correctamente.
{
"topic" : "test",
"partitions" : [ {
"partition" : 0,
"leader" : 2,
"replicas" : [ {
"broker" : 2,
"leader" : true,
"in_sync" : true,
"size" : 123971146,
"lag" : 0
}, {
"broker" : 1,
"leader" : false,
"in_sync" : true,
"size" : 123971146,
"lag" : 0
}, {
"broker" : 0,
"leader" : false,
"in_sync" : true,
"size" : 123971146,
"lag" : 0
} ],
"lso" : 0,
"leo" : 13598,
"hw" : 13598,
"last_update_timestamp" : 1571477180985
}, {
"partition" : 2,
"leader" : 1,
"replicas" : [ {
"broker" : 1,
"leader" : true,
"in_sync" : true,
"size" : 123889531,
"lag" : 0
}, {
"broker" : 0,
"leader" : false,
"in_sync" : true,
"size" : 123889531,
"lag" : 0
}, {
"broker" : 2,
"leader" : false,
"in_sync" : true,
"size" : 123889531,
"lag" : 0
} ],
"lso" : 0,
"leo" : 13601,
"hw" : 13601,
"last_update_timestamp" : 1571477077146
}, {
"partition" : 1,
"leader" : 0,
"replicas" : [ {
"broker" : 0,
"leader" : true,
"in_sync" : true,
"size" : 127245604,
"lag" : 0
}, {
"broker" : 2,
"leader" : false,
"in_sync" : true,
"size" : 127245604,
"lag" : 0
}, {
"broker" : 1,
"leader" : false,
"in_sync" : true,
"size" : 127245604,
"lag" : 0
} ],
"lso" : 0,
"leo" : 13599,
"hw" : 13599,
"last_update_timestamp" : 1571477172959
} ],
"group_subscribed" : [ "test-consumer-group" ]
}
Códigos de estado
|
Código de estado |
Descripción |
|---|---|
|
200 |
La consulta se realiza correctamente. |
Códigos de error
Consulte Códigos de error.