Consulta da lista de especificações do produto
Função
Essa API é usada para consultar a lista de especificações do produto.
Método de chamada
Para obter detalhes, consulte Chamada de APIs.
URI
GET /v2/{engine}/products
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
engine |
Sim |
String |
Mecanismo de mensagens. Padrão: kafka |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
product_id |
Não |
String |
ID do produto. |
Parâmetros de solicitação
Nenhum
Parâmetros de resposta
Código de status: 200
Parâmetro |
Tipo |
Descrição |
---|---|---|
engine |
String |
Mecanismo de mensagens do DMS. |
versions |
Array of strings |
Versões suportadas. |
products |
Array of ListEngineProductsEntity objects |
Detalhes da especificação do produto. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
type |
String |
Tipo de produto. Atualmente, os tipos de nó único e cluster são suportados. |
product_id |
String |
ID do produto. |
ecs_flavor_id |
String |
Flavor do ECS. |
billing_code |
String |
Modo de cobrança. |
arch_types |
Array of strings |
Arquitetura da CPU. |
charging_mode |
Array of strings |
Modo de cobrança. monthly: anual/mensal; hourly: pagamento por uso |
ios |
Array of ListEngineIosEntity objects |
Lista de tipos de I/O de disco suportados. |
support_features |
Array of ListEngineSupportFeaturesEntity objects |
Lista de recursos suportados por instâncias das especificações atuais. |
properties |
ListEnginePropertiesEntity object |
Atributo de instâncias das especificações atuais. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
io_spec |
String |
Código de I/O do disco. |
type |
String |
Tipo de disco. |
available_zones |
Array of strings |
AZs disponíveis. |
unavailable_zones |
Array of strings |
AZs indisponíveis. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
name |
String |
Nome de recursos. |
properties |
Descrição dos recursos suportados pela instância. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
max_task |
String |
Número máximo de tarefas de despejo. |
min_task |
String |
Número mínimo de tarefas de despejo. |
max_node |
String |
Número máximo de nós de despejo. |
min_node |
String |
Número mínimo de nós de despejo. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
max_partition_per_broker |
String |
Número máximo de partições de cada corretor. |
max_broker |
String |
Número máximo de corretores. |
max_storage_per_node |
String |
Espaço máximo de armazenamento de cada corretor. A unidade é GB. |
max_consumer_per_broker |
String |
Número máximo de consumidores de cada corretor. |
min_broker |
String |
Número mínimo de corretores. |
max_bandwidth_per_broker |
String |
Largura de banda máxima de cada corretor. |
min_storage_per_node |
String |
Espaço mínimo de armazenamento de cada corretor. A unidade é GB. |
max_tps_per_broker |
String |
TPS máximo de cada corretor. |
product_alias |
String |
Alias de product_id. |
Exemplo de solicitações
GET https://{endpoint}/v2/kafka/products
Exemplo de respostas
Código de status: 200
As especificações do produto são listadas com sucesso.
-
Bem-sucedido.
{ "engine" : "kafka", "versions" : [ "1.1.0", "2.3.0" ], "products" : [ { "type" : "cluster", "product_id" : "c6.2u4g.cluster", "ecs_flavor_id" : "c6.large.2", "billing_code" : "dms.platinum.c6", "arch_types" : [ "X86" ], "charging_mode" : [ "monthly", "hourly" ], "ios" : [ { "io_spec" : "dms.physical.storage.high.v2", "type" : "evs", "available_zones" : [ "xxx", "xxx" ], "unavailable_zones" : [ "xxx", "xxx" ] }, { "io_spec" : "dms.physical.storage.ultra.v2", "type" : "evs", "available_zones" : [ "xxx", "xxx" ], "unavailable_zones" : [ "xxx", "xxx" ] } ], "support_features" : [ { "name" : "connector_obs", "properties" : { "max_task" : "10", "max_node" : "10", "min_task" : "1", "min_node" : "2" } } ], "properties" : { "max_partition_per_broker" : "250", "max_broker" : "30", "max_storage_per_node" : "10000", "max_consumer_per_broker" : "4000", "min_broker" : "3", "max_bandwidth_per_broker" : "100", "min_storage_per_node" : "200", "max_tps_per_broker" : "30000", "product_alias" : "kafka.2u4g.cluster" } }, { "type" : "cluster", "product_id" : "c6.4u8g.cluster", "ecs_flavor_id" : "c6.xlarge.2", "billing_code" : "dms.platinum.c6", "arch_types" : [ "X86" ], "charging_mode" : [ "monthly", "hourly" ], "ios" : [ { "io_spec" : "dms.physical.storage.high.v2", "type" : "evs", "available_zones" : [ "xxx", "xxx" ], "unavailable_zones" : [ "xxx", "xxx" ] }, { "io_spec" : "dms.physical.storage.ultra.v2", "type" : "evs", "available_zones" : [ "xxx", "xxx" ], "unavailable_zones" : [ "xxx", "xxx" ] } ], "support_features" : [ { "name" : "connector_obs", "properties" : { "max_task" : "10", "max_node" : "10", "min_task" : "1", "min_node" : "2" } } ], "properties" : { "max_partition_per_broker" : "500", "max_broker" : "30", "max_storage_per_node" : "20000", "max_consumer_per_broker" : "4000", "min_broker" : "3", "max_bandwidth_per_broker" : "100", "min_storage_per_node" : "400", "max_tps_per_broker" : "100000", "product_alias" : "kafka.4u8g.cluster" } }, { "type" : "cluster", "product_id" : "c6.8u16g.cluster", "ecs_flavor_id" : "c6.2xlarge.2", "billing_code" : "dms.platinum.c6", "arch_types" : [ "X86" ], "charging_mode" : [ "monthly", "hourly" ], "ios" : [ { "io_spec" : "dms.physical.storage.high.v2", "type" : "evs", "available_zones" : [ "xxx", "xxx" ], "unavailable_zones" : [ "xxx", "xxx" ] }, { "io_spec" : "dms.physical.storage.ultra.v2", "type" : "evs", "available_zones" : [ "xxx", "xxx" ], "unavailable_zones" : [ "xxx", "xxx" ] } ], "support_features" : [ { "name" : "connector_obs", "properties" : { "max_task" : "10", "max_node" : "10", "min_task" : "1", "min_node" : "2" } } ], "properties" : { "max_partition_per_broker" : "1000", "max_broker" : "30", "max_storage_per_node" : "30000", "max_consumer_per_broker" : "4000", "min_broker" : "3", "max_bandwidth_per_broker" : "100", "min_storage_per_node" : "800", "max_tps_per_broker" : "150000", "product_alias" : "kafka.8u16g.cluster" } }, { "type" : "cluster", "product_id" : "c6.12u24g.cluster", "ecs_flavor_id" : "c6.3xlarge.2", "billing_code" : "dms.platinum.c6", "arch_types" : [ "X86" ], "charging_mode" : [ "monthly", "hourly" ], "ios" : [ { "io_spec" : "dms.physical.storage.high.v2", "type" : "evs", "available_zones" : [ "xxx", "xxx" ], "unavailable_zones" : [ "xxx", "xxx" ] }, { "io_spec" : "dms.physical.storage.ultra.v2", "type" : "evs", "available_zones" : [ "xxx", "xxx" ], "unavailable_zones" : [ "xxx", "xxx" ] } ], "support_features" : [ { "name" : "connector_obs", "properties" : { "max_task" : "10", "max_node" : "10", "min_task" : "1", "min_node" : "2" } } ], "properties" : { "max_partition_per_broker" : "1500", "max_broker" : "30", "max_storage_per_node" : "30000", "max_consumer_per_broker" : "4000", "min_broker" : "3", "max_bandwidth_per_broker" : "100", "min_storage_per_node" : "1200", "max_tps_per_broker" : "200000", "product_alias" : "kafka.12u24g.cluster" } }, { "type" : "cluster", "product_id" : "c6.16u32g.cluster", "ecs_flavor_id" : "c6.4xlarge.2", "billing_code" : "dms.platinum.c6", "arch_types" : [ "X86" ], "charging_mode" : [ "monthly", "hourly" ], "ios" : [ { "io_spec" : "dms.physical.storage.high.v2", "type" : "evs", "available_zones" : [ "xxx", "xxx" ], "unavailable_zones" : [ "xxx", "xxx" ] }, { "io_spec" : "dms.physical.storage.ultra.v2", "type" : "evs", "available_zones" : [ "xxx", "xxx" ], "unavailable_zones" : [ "xxx", "xxx" ] } ], "support_features" : [ { "name" : "connector_obs", "properties" : { "max_task" : "10", "max_node" : "10", "min_task" : "1", "min_node" : "2" } } ], "properties" : { "max_partition_per_broker" : "2000", "max_broker" : "30", "max_storage_per_node" : "30000", "max_consumer_per_broker" : "4000", "min_broker" : "3", "max_bandwidth_per_broker" : "100", "min_storage_per_node" : "1600", "max_tps_per_broker" : "250000", "product_alias" : "kafka.16u32g.cluster" } } ] }
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 |
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 ListEngineProductsSolution { 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"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); KafkaClient client = KafkaClient.newBuilder() .withCredential(auth) .withRegion(KafkaRegion.valueOf("<YOUR REGION>")) .build(); ListEngineProductsRequest request = new ListEngineProductsRequest(); request.withEngine(ListEngineProductsRequest.EngineEnum.fromValue("{engine}")); try { ListEngineProductsResponse response = client.listEngineProducts(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 |
# 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") credentials = BasicCredentials(ak, sk) \ client = KafkaClient.new_builder() \ .with_credentials(credentials) \ .with_region(KafkaRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListEngineProductsRequest() request.engine = "{engine}" response = client.list_engine_products(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 |
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") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := kafka.NewKafkaClient( kafka.KafkaClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListEngineProductsRequest{} request.Engine = model.GetListEngineProductsRequestEngineEnum().ENGINE response, err := client.ListEngineProducts(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 |
As especificações do produto são listadas com sucesso. |
Códigos de erro
Consulte Códigos de erro.