Listagem dos tópicos de uma instância de Kafka
Função
Essa API é usada para consultar detalhes sobre tópicos de uma instância do Kafka.
Método de chamada
Para obter detalhes, consulte Chamada de APIs.
URI
GET /v2/{project_id}/instances/{instance_id}/topics
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
project_id |
Sim |
String |
ID do projeto. Para obter detalhes sobre como obtê-lo, consulte Obtenção de um ID de projeto. |
instance_id |
Sim |
String |
ID da instância. |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
offset |
Não |
String |
Deslocamento, que é a posição onde a consulta começa. O valor deve ser maior ou igual a 0. |
limit |
Não |
String |
Número máximo de instâncias retornadas na consulta atual. O valor padrão é 10. O valor varia de 1 a 50. |
Parâmetros de solicitação
Nenhum
Parâmetros de resposta
Código de status: 200
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. |
topic_max_partitions |
Integer |
Número máximo de partições em um único tópico. |
topics |
Array of TopicEntity objects |
Lista de tópicos. |
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 liberação síncrona está ativada. O valor padrão é false. A liberação síncrona 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). |
topic_other_configs |
Array of topic_other_configs objects |
Outras configurações de tópicos. |
topic_desc |
String |
Descrição do tópico. |
created_at |
Long |
Tempo de criação do tópico. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
name |
String |
Nome da configuração. |
valid_values |
String |
Valor válido. |
default_value |
String |
Valor padrão. |
config_type |
String |
Tipo de configuração. O valor pode ser dynamic ou static. |
value |
String |
Valor de configuração. |
value_type |
String |
Tipo de valor de configuração. |
Exemplo de solicitações
Consulta da lista de tópicos
GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/topics?offset=0&limit=10
Exemplo de respostas
Código de status: 200
A consulta foi bem-sucedida.
{ "total" : 1, "size" : 0, "topics" : [ { "policiesOnly" : false, "name" : "Topic-test01", "replication" : 3, "partition" : 3, "retention_time" : 72, "sync_replication" : "false", "sync_message_flush" : "false", "topic_other_configs" : [ { "name" : "max.message.bytes", "valid_values" : "[0...10485760]", "default_value" : "10485760", "config_type" : "dynamic", "value" : "10485760", "value_type" : "int" }, { "name" : "message.timestamp.type", "valid_values" : "[CreateTime, LogAppendTime]", "default_value" : "LogAppendTime", "config_type" : "dynamic", "value" : "LogAppendTime", "value_type" : "string" } ], "external_configs" : { }, "topic_type" : 0, "topic_desc" : "This is a test topic", "created_at" : 1688112779916 } ], "remain_partitions" : 294, "max_partitions" : 300, "topic_max_partitions" : 200 }
Código de exemplo do SDK
O código de exemplo do SDK é o seguinte.
Java
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.kafka.v2.region.KafkaRegion; import com.huaweicloud.sdk.kafka.v2.*; import com.huaweicloud.sdk.kafka.v2.model.*; public class ListInstanceTopicsSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); KafkaClient client = KafkaClient.newBuilder() .withCredential(auth) .withRegion(KafkaRegion.valueOf("<YOUR REGION>")) .build(); ListInstanceTopicsRequest request = new ListInstanceTopicsRequest(); request.withInstanceId("{instance_id}"); try { ListInstanceTopicsResponse response = client.listInstanceTopics(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Python
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 |
# coding: utf-8 from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkkafka.v2.region.kafka_region import KafkaRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkkafka.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = __import__('os').getenv("CLOUD_SDK_AK") sk = __import__('os').getenv("CLOUD_SDK_SK") projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) \ client = KafkaClient.new_builder() \ .with_credentials(credentials) \ .with_region(KafkaRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListInstanceTopicsRequest() request.instance_id = "{instance_id}" response = client.list_instance_topics(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Go
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" kafka "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kafka/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kafka/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kafka/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := kafka.NewKafkaClient( kafka.KafkaClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListInstanceTopicsRequest{} request.InstanceId = "{instance_id}" response, err := client.ListInstanceTopics(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
Mais
Para obter o código de exemplo do SDK de mais linguagens de programação, consulte a guia Código de exemplo no API Explorer. O código de exemplo do SDK pode ser gerado automaticamente.
Códigos de status
Código de status |
Descrição |
---|---|
200 |
A consulta foi bem-sucedida. |
Códigos de erro
Consulte Códigos de erro.