Listado de temas de una instancia de Kafka
Función
Esta API se utiliza para consultar detalles sobre temas de una instancia de Kafka.
URI
GET /v2/{project_id}/instances/{instance_id}/topics
Parámetro | Obligatorio | 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 |
|---|---|---|
total | Integer | Número total de temas. |
size | Integer | Número máximo de registros que se mostrarán en una página. |
remain_partitions | Integer | Número de particiones restantes. |
max_partitions | Integer | Número total de particiones. |
topics | Array of TopicEntity objects | Lista de temas. |
Parámetro | Tipo | Descripción |
|---|---|---|
policiesOnly | Boolean | Si esta política es la política predeterminada. |
name | String | Nombre del tema |
replication | Integer | Número de réplicas, que se configura para garantizar la fiabilidad de los datos. |
partition | Integer | Número de particiones de tema, que se utiliza para establecer el número de mensajes consumidos simultáneamente. |
retention_time | Integer | Período de retención de un mensaje. |
sync_replication | Boolean | Si la replicación síncrona está habilitada. Después de activar esta función, el parámetro acks en el cliente productor debe establecerse en –1. En caso contrario, este parámetro no tiene efecto. |
sync_message_flush | Boolean | Si el vaciado síncrono está habilitado. El valor predeterminado es false. El lavado síncrono compromete el rendimiento. |
external_configs | Object | Configuración extendida. |
topic_type | Integer | Tipo de tema. Opciones: 0: tema común; 1: tema del sistema (interno). |
Ejemplo de las solicitudes
GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/topics Ejemplo de las respuestas
Código de estado: 200
La consulta se realiza correctamente.
{
"total" : 3,
"size" : 3,
"topics" : [ {
"policiesOnly" : false,
"name" : "topic-11",
"replication" : 3,
"partition" : 3,
"retention_time" : 72,
"sync_replication" : false,
"sync_message_flush" : false,
"external_configs" : { },
"topic_type" : 0
}, {
"policiesOnly" : false,
"name" : "topic-2077405901",
"replication" : 3,
"partition" : 3,
"retention_time" : 72,
"sync_replication" : false,
"sync_message_flush" : true,
"external_configs" : { },
"topic_type" : 0
}, {
"policiesOnly" : false,
"name" : "topic-test",
"replication" : 3,
"partition" : 3,
"retention_time" : 1,
"sync_replication" : true,
"sync_message_flush" : false,
"external_configs" : { },
"topic_type" : 0
} ]
} 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.
