Consulta de un tema en una instancia de Kafka
Esta API está desactualizada y es posible que no se mantenga en el futuro. Utilice la API descrita en listado de temas de una instancia de Kafka.
Función
Esta API se utiliza para consultar detalles sobre un tema en una instancia de Kafka.
Solicitud
Parámetros de solicitud
No hay.
Solicitud de ejemplo
GET https://{dms_endpoint}/v1.0/{project_id}/instances/{instance_id}/topics
Respuesta
Parámetros de respuesta
Tabla 2 describe el parámetro de respuesta.
Parámetro |
Tipo |
Descripción |
|---|---|---|
total |
Integer |
Indica el número total de temas. |
size |
Integer |
Indica el número máximo de registros que se mostrarán en una página. |
remain_partitions |
Integer |
Indica el número de particiones restantes. |
max_partitions |
Integer |
Indica el número total de particiones. |
topics |
Array |
Indica la lista de temas. |
Parámetro |
Tipo |
Descripción |
|---|---|---|
policiesOnly |
Boolean |
Si esta política es la política predeterminada. |
id |
String |
Indica el nombre del tema. |
replication |
Integer |
Indica el número de réplicas, que se configura para garantizar la fiabilidad de los datos. |
partition |
Integer |
Indica el número de particiones de tema, que se utiliza para establecer el número de mensajes consumidos simultáneamente. |
retention_time |
Integer |
Indica el período de retención de un mensaje. |
sync_replication |
Boolean |
Indica si se debe habilitar la replicación síncrona. 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. De forma predeterminada, la replicación síncrona está deshabilitada. |
sync_message_flush |
Boolean |
Indica si se activa el vaciado síncrono. El lavado síncrono compromete el rendimiento. |
external_configs |
Object |
Indica la configuración extendida. |
topic_type |
Integer |
Indica el tipo de tema. |
Ejemplo de respuesta
{
"count": 1,
"topics": [
{
"id": "topic-test",
"replication": 3,
"partition": 4,
"retention_time": 72,
"sync_replication": "false",
"sync_message_flush": "false"
}
]
}
Código de estado
Tabla 4 describe el código de estado de las operaciones exitosas. Para obtener más información sobre el código de estado, consulte Código de estado.
