Consulta das dimensões de monitoramento de instâncias do Kafka
Função
Essa API é usada para consultar dimensões de monitoramento de instâncias do Kafka.
Método de chamada
Para obter detalhes, consulte Chamada de APIs.
URI
GET /v2/{project_id}/instances/{instance_id}/ces-hierarchy
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âmetros de solicitação
Nenhum
Parâmetros de resposta
Código de status: 200
Parâmetro |
Tipo |
Descrição |
---|---|---|
dimensions |
Array of dimensions objects |
Dimensões de monitoramento. |
instance_ids |
Array of instance_ids objects |
Informações da instância. |
nodes |
Array of nodes objects |
Informações do corretor. |
queues |
Array of queues objects |
Informação do tópico. |
groups |
Array of groups objects |
Informações do grupo de consumidores. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
name |
String |
Nome da dimensão de monitoramento. |
metrics |
Array of strings |
Nome da métrica. |
key_name |
Array of strings |
Chave usada para a consulta de monitoramento. |
dim_router |
Array of strings |
Rota da dimensão de monitoramento. |
children |
Array of children objects |
Lista de dimensões secundárias. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
name |
String |
Nome da dimensão secundária. |
metrics |
Array of strings |
Métricas na dimensão secundária. |
key_name |
Array of strings |
Chave usada para a consulta de monitoramento. |
dim_router |
Array of strings |
Rota da dimensão de monitoramento. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
name |
String |
Nome do tópico. |
partitions |
Array of partitions objects |
Lista de partições. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
name |
String |
Nome do grupo de consumidores. |
queues |
Array of queues objects |
Informação do tópico. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
name |
String |
Nome do tópico. |
partitions |
Array of partitions objects |
Informação da partição. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
name |
String |
Nome da partição. |
Exemplo de solicitações
GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/ces-hierarchy
Exemplo de respostas
Código de status: 200
A consulta foi bem-sucedida.
{ "dimensions" : [ { "name" : "kafka_instance_id", "metrics" : [ "current_partitions", "current_topics", "group_messages" ], "key_name" : [ "instance_ids" ], "dim_router" : [ "kafka_instance_id" ] }, { "name" : "kafka_broker", "metrics" : [ "broker_data_size", "broker_messages_in_rate", "broker_bytes_out_rate", "broker_bytes_in_rate", "broker_produce_mean", "broker_fetch_mean" ], "key_name" : [ "nodes" ], "dim_router" : [ "kafka_instance_id", "kafka_broker" ] }, { "name" : "kafka_rest", "metrics" : [ "rest_produce_success", "rest_produce_failed", "rest_produce_latency", "rest_produce_msg_num", "rest_produce_flow", "rest_consume_success", "rest_consume_failed", "rest_consume_latency", "rest_consume_msg_num", "rest_consume_flow", "rest_commit_success", "rest_commit_failed", "rest_commit_latency", "rest_commit_msg_num", "rest_commit_flow" ], "key_name" : [ "nodes" ], "dim_router" : [ "kafka_instance_id", "kafka_rest" ] }, { "name" : "kafka_topics", "metrics" : [ "topic_data_size", "topic_messages_in_rate", "topic_bytes_out_rate", "topic_bytes_in_rate", "topic_messages" ], "key_name" : [ "queues" ], "dim_router" : [ "kafka_instance_id", "kafka_topics" ], "children" : [ { "name" : "kafka_partitions", "metrics" : [ "produced_messages", "partition_messages" ], "key_name" : [ "queues", "partitions" ], "dim_router" : [ "kafka_instance_id", "kafka_topics", "kafka_partitions" ] } ] }, { "name" : "kafka_groups_partitions", "metrics" : [ "messages_consumed", "messages_remained" ], "key_name" : [ "groups", "queues", "partitions" ], "dim_router" : [ "kafka_instance_id", "kafka_groups", "kafka_groups_topics", "kafka_groups_partitions" ] } ], "instance_ids" : [ { "name" : "68f3f6a0-3741-453b-bda9-a6ff6b5bb6f7" } ], "nodes" : [ { "name" : "broker-0" }, { "name" : "broker-1" }, { "name" : "broker-2" } ], "queues" : [ { "name" : "aaaa", "partitions" : [ { "name" : "0" } ] }, { "name" : "mytest", "partitions" : [ { "name" : "0" }, { "name" : "1" }, { "name" : "2" } ] }, { "name" : "topic-84234378", "partitions" : [ { "name" : "0" }, { "name" : "1" }, { "name" : "2" } ] } ], "groups" : [ { "name" : "test-consumer-group", "queues" : [ { "name" : "mytest", "partitions" : [ { "name" : "0" }, { "name" : "1" }, { "name" : "2" } ] } ] } ] }
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 ShowCesHierarchySolution { 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(); ShowCesHierarchyRequest request = new ShowCesHierarchyRequest(); request.withInstanceId("{instance_id}"); try { ShowCesHierarchyResponse response = client.showCesHierarchy(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 = ShowCesHierarchyRequest() request.instance_id = "{instance_id}" response = client.show_ces_hierarchy(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.ShowCesHierarchyRequest{} request.InstanceId = "{instance_id}" response, err := client.ShowCesHierarchy(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.