Consulta de detalhes do tópico
Função
Essa API é usada para consultar detalhes de tópicos de uma instância do Kafka. (Até 1s para cada chamada de instância)
Método de chamada
Para obter detalhes, consulte Chamada de APIs.
URI
GET /v2/{project_id}/instances/{instance_id}/management/topics/{topic}
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. |
topic |
Sim |
String |
Nome do tópico. |
Parâmetros de solicitação
Nenhum
Parâmetros de resposta
Código de status: 200
Parâmetro |
Tipo |
Descrição |
---|---|---|
topic |
String |
Nome do tópico. |
partitions |
Array of partitions objects |
Lista de partições. |
group_subscribed |
Array of strings |
Lista de grupos de consumidores que assinam o tópico. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
partition |
Integer |
ID da partição. |
leader |
Integer |
ID do corretor onde reside a réplica líder. |
leo |
Integer |
LEO da réplica líder de partição. |
hw |
Integer |
Marca d'água alta (HW) da partição. |
lso |
Integer |
Deslocamento de início de log (LSO) da réplica líder da partição. |
last_update_timestamp |
Long |
Hora em que a última mensagem foi gravada na partição. O valor é um carimbo de data/hora Unix. Unidade: ms |
replicas |
Array of replicas objects |
Lista de réplicas. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
broker |
Integer |
ID do corretor onde reside a réplica. |
leader |
Boolean |
Se a réplica é o líder. |
in_sync |
Boolean |
Se a réplica está em ISR. |
size |
Integer |
Tamanho atual do log da réplica. Unidade: byte. |
lag |
Long |
Número de mensagens que ficam atrás da marca d'água alta na réplica. |
Exemplo de solicitações
Consulta de detalhes sobre um tópico especificado
GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/management/topics/{topic}
Exemplo de respostas
Código de status: 200
A consulta foi bem-sucedida.
{ "topic" : "test", "partitions" : [ { "partition" : 0, "leader" : 2, "replicas" : [ { "broker" : 2, "leader" : true, "in_sync" : true, "size" : 123971146, "lag" : 0 }, { "broker" : 1, "leader" : false, "in_sync" : true, "size" : 123971146, "lag" : 0 }, { "broker" : 0, "leader" : false, "in_sync" : true, "size" : 123971146, "lag" : 0 } ], "lso" : 0, "leo" : 13598, "hw" : 13598, "last_update_timestamp" : 1571477180985 }, { "partition" : 2, "leader" : 1, "replicas" : [ { "broker" : 1, "leader" : true, "in_sync" : true, "size" : 123889531, "lag" : 0 }, { "broker" : 0, "leader" : false, "in_sync" : true, "size" : 123889531, "lag" : 0 }, { "broker" : 2, "leader" : false, "in_sync" : true, "size" : 123889531, "lag" : 0 } ], "lso" : 0, "leo" : 13601, "hw" : 13601, "last_update_timestamp" : 1571477077146 }, { "partition" : 1, "leader" : 0, "replicas" : [ { "broker" : 0, "leader" : true, "in_sync" : true, "size" : 127245604, "lag" : 0 }, { "broker" : 2, "leader" : false, "in_sync" : true, "size" : 127245604, "lag" : 0 }, { "broker" : 1, "leader" : false, "in_sync" : true, "size" : 127245604, "lag" : 0 } ], "lso" : 0, "leo" : 13599, "hw" : 13599, "last_update_timestamp" : 1571477172959 } ], "group_subscribed" : [ "test-consumer-group" ] }
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 49 |
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 ShowInstanceTopicDetailSolution { 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(); ShowInstanceTopicDetailRequest request = new ShowInstanceTopicDetailRequest(); request.withInstanceId("{instance_id}"); request.withTopic("{topic}"); try { ShowInstanceTopicDetailResponse response = client.showInstanceTopicDetail(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 32 |
# 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 = ShowInstanceTopicDetailRequest() request.instance_id = "{instance_id}" request.topic = "{topic}" response = client.show_instance_topic_detail(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 39 |
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.ShowInstanceTopicDetailRequest{} request.InstanceId = "{instance_id}" request.Topic = "{topic}" response, err := client.ShowInstanceTopicDetail(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.