Este conteúdo foi traduzido por máquina para sua conveniência e a Huawei Cloud não pode garantir que o conteúdo foi traduzido com precisão. Para exibir o conteúdo original, use o link no canto superior direito para mudar para a página em inglês.

Central de ajuda> Distributed Message Service for Kafka> Referência de API> As API V2 (Recomendado)> Gerenciamento de tópicos> ListInstanceTopics

Atualizado em 2022-11-07 GMT+08:00

Ver PDF

ListInstanceTopics

Função

Essa API é usada para consultar detalhes sobre tópicos de uma instânciade Kafka.

URI

GET /v2/{project_id}/instances/{instance_id}/topics

**Tabela 1** Parâmetros de caminho
Parâmetro	Obrigatório	Tipo	Descrição
project_id	Sim	String	ID do projeto.
instance_id	Sim	String	ID da instância.

Parâmetros de solicitação

Nenhum

Parâmetros de resposta

Código de estado: 200

**Tabela 2** Parâmetros do corpo de resposta
Parâmetro	Tipo	Descrição
total	Integer	Número total de tópicos.
size	Integer	Número máximo de registros a serem exibidos em uma página.
remain_partitions	Integer	Número de partições restantes.
max_partitions	Integer	Número total de partições.
topics	Array of TopicEntity objects	Lista de tópicos.

**Tabela 3** TopicEntity
Parâmetro	Tipo	Descrição
policiesOnly	Boolean	Se esta política é a política padrão.
name	String	Nome do tópico.
replication	Integer	Número de réplicas, que é configurado para garantir a confiabilidade dos dados.
partition	Integer	Número de partições de tópico, que é usado para definir o número de mensagens consumidas simultaneamente.
retention_time	Integer	Período de retenção de uma mensagem.
sync_replication	Boolean	Se a replicação síncrona está 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.
sync_message_flush	Boolean	Se a descarga síncrona está ativada. O valor padrão é false. O rubor síncrono compromete o desempenho.
external_configs	Object	Configuração estendida.
topic_type	Integer	Tipo de tópico. Opções: 0: tópico comum; 1: tópico do sistema (interno).

Exemplos de solicitações

GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/topics

Exemplo de respostas

Código de estado: 200

A consulta foi sucedida.

{ "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 } ] }