Consulta de um tópico em uma instância de Kafka
Esta API está desatualizada e pode não ser mantida no futuro. Use a API descrita em Lista dos tópicos de uma instância de Kafka.
Função
Essa API é usada para consultar detalhes sobre um tópico em uma instância de Kafka.
Solicitação
Parâmetros de solicitação
Nenhum.
Exemplos de solicitações
GET https://{dms_endpoint}/v1.0/{project_id}/instances/{instance_id}/topics
Resposta
Parâmetros de resposta
Tabela 2 descreve os parâmetros de resposta.
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
total |
Integer |
Indica o número total de tópicos. |
|
size |
Integer |
Indica o número máximo de registros a serem exibidos em uma página. |
|
remain_partitions |
Integer |
Indica o número de partições restantes. |
|
max_partitions |
Integer |
Indica o número total de partições. |
|
topics |
Array |
Indica a lista de tópicos. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
policiesOnly |
Boolean |
Se esta política é a política padrão. |
|
id |
String |
Indica o nome do tópico. |
|
replication |
Integer |
Indica o número de réplicas, que é configurado para garantir a confiabilidade dos dados. |
|
partition |
Integer |
Indica o número de partições de tópico, que é usado para definir o número de mensagens consumidas simultaneamente. |
|
retention_time |
Integer |
Indica o período de retenção de uma mensagem. |
|
sync_replication |
Boolean |
Indica se a replicação síncrona deve ser ativada. Depois que essa função for ativada, o parâmetro acks no cliente do produtor deve ser definido como –1. Caso contrário, esse parâmetro não terá efeito. Por predefinição, a replicação síncrona está desactivada. |
|
sync_message_flush |
Boolean |
Indica se o esvaziamento síncrono deve ser ativado. O rubor síncrono compromete o desempenho. |
|
external_configs |
Object |
Indica a configuração estendida. |
|
topic_type |
Integer |
Indica o tipo de tópico. |
Exemplo de respostas
{
"count": 1,
"topics": [
{
"id": "topic-test",
"replication": 3,
"partition": 4,
"retention_time": 72,
"sync_replication": "false",
"sync_message_flush": "false"
}
]
}
Código de status
Tabela 4 descreve o código de status das operações sucedidas. Para obter detalhes sobre outros códigos de status, consulte Código de status.
