ListInstances
Função
Essa API é usada para consultar as instâncias de uma conta pelas condições especificadas.
URI
GET /v2/{project_id}/instances
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
project_id |
Sim |
String |
ID do projeto. |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
engine |
Não |
String |
Motor de mensagens. Valor: kafka. |
name |
Não |
String |
Nome da instância. |
instance_id |
Não |
String |
ID da instância. |
status |
Não |
String |
Status da instância. |
include_failure |
Não |
String |
Se retornar o número de instâncias que falham ao serem criadas. Se o valor for true, o número de instâncias que falharam ao serem criadas será retornado. Se o valor não for true, o número não será retornado. |
exact_match_name |
Não |
String |
Se deve procurar a instância que corresponde precisamente a um nome de instância especificado. O valor padrão é false*, indicando que uma pesquisa difusa é executada com base em um nome de instância especificado. Se o valor for true, a instância que corresponde precisamente a um nome de instância especificado será consultada. |
enterprise_project_id |
Não |
String |
ID do projeto empresarial. |
Parâmetros de solicitação
Nenhum
Parâmetros de resposta
Código de estado: 200
Parâmetro |
Tipo |
Descrição |
---|---|---|
instances |
Array of ShowInstanceResp objects |
Lista de instância. |
instance_num |
Integer |
Número de instâncias. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
name |
String |
Nome da instância. |
engine |
String |
Motor de mensagens. |
engine_version |
String |
Versões. |
description |
String |
Descrição da instância |
specification |
String |
Especificações da instância. |
storage_space |
Integer |
Espaço de armazenamento de mensagens em GB. |
partition_num |
String |
Número de partições em uma instância de Kafka. |
used_storage_space |
Integer |
Usado espaço de armazenamento de mensagens em GB. |
connect_address |
String |
Endereço IP de uma instância. |
port |
Integer |
Porta de uma instância. |
status |
String |
Instance status.For details, see "Instance Status" (https://support.huaweicloud.com/intl/pt-br/api-kafka/kafka-api-180514012.html). |
instance_id |
String |
ID da instância. |
resource_spec_code |
String |
Código de especificação do recurso.
|
charging_mode |
Integer |
Modo de cobrança. Opções: 1: pay-per-use; 0: anual/mensal. |
vpc_id |
String |
ID de VPC |
vpc_name |
String |
Nome da VPC. |
created_at |
String |
Hora em que a instância foi criada. A hora está no formato de timestamp, ou seja, os milissegundos de offset de 1970-01-01 00:00:00 UTC até a hora especificada. |
subnet_name |
String |
Nome da sub-rede. |
subnet_cidr |
String |
Bloco CIDR da sub-rede. |
user_id |
String |
ID do usuário. |
user_name |
String |
Nome de usuário. |
access_user |
String |
Nome de usuário para acessar a instância. |
order_id |
String |
ID do pedido. Este parâmetro tem um valor apenas quando o modo de faturação é anual/mensal. |
maintain_begin |
String |
Hora em que a janela de tempo de manutenção começa. O formato é HH:mm:ss. |
maintain_end |
String |
Hora em que a janela de tempo de manutenção termina. O formato é HH:mm:ss. |
enable_publicip |
Boolean |
Se o acesso público está habilitado para a instância.
|
management_connect_address |
String |
Endereço de conexão do Kafka Manager da instância de Kafka. |
ssl_enable |
Boolean |
Se a autenticação de segurança está ativada.
|
ssl_two_way_enable |
Boolean |
Indica se a autenticação bidirecional deve ser ativada. |
cert_replaced |
Boolean |
Se o certificado pode ser substituído. |
public_management_connect_address |
String |
Endereço para acessar o Kafka Manager em redes públicas. |
enterprise_project_id |
String |
ID do projeto empresarial. |
is_logical_volume |
Boolean |
Se a instância é uma nova instância. Esse parâmetro é usado para distinguir instâncias antigas de instâncias novas durante a expansão da capacidade da instância.
|
extend_times |
Integer |
Número de tempos de expansão do disco. Se o valor exceder 20, a expansão do disco não será mais permitida. |
enable_auto_topic |
Boolean |
Se a criação automática de tópicos está ativada.
|
type |
String |
Tipos de instância. O valor pode ser cluster. |
product_id |
Boolean |
ID do produto. |
security_group_id |
String |
ID do grupo de segurança. |
security_group_name |
String |
Nome do grupo de segurança. |
subnet_id |
String |
ID da sub-rede. |
available_zones |
Array of strings |
AZ ao qual os corretores de instância pertencem. O ID AZ é retornado. |
total_storage_space |
Integer |
Espaço de armazenamento de mensagens em GB. |
public_connect_address |
String |
Endereço de acesso público da instância. Esse parâmetro está disponível somente quando o acesso público está habilitado para a instância. |
storage_resource_id |
String |
ID do recurso de armazenamento. |
storage_spec_code |
String |
Especificações de E/S. |
service_type |
String |
Tipo de serviço. |
storage_type |
String |
classe de armazenamento. |
retention_policy |
String |
Política de retenção de mensagens. |
kafka_public_status |
String |
Se o acesso público está habilitado para o Kafka. |
public_bandwidth |
Integer |
Largura de banda de acesso à rede pública. |
kafka_manager_user |
String |
Nome de usuário para fazer login no Kafka Manager. |
enable_log_collection |
Boolean |
Se a coleta de log está ativada. |
cross_vpc_info |
String |
Informações de acesso Cross-VPC. |
ipv6_enable |
Boolean |
Se o IPv6 está ativado. |
ipv6_connect_addresses |
Array of strings |
Endereço de conexão IPv6. |
connector_enable |
Boolean |
Se o despejo está ativado. O despejo não é suportado para o novo tipo de especificação. |
connector_id |
String |
ID da tarefa de despejo. |
rest_enable |
Boolean |
Se o Kafka REST está habilitado. |
rest_connect_address |
String |
Endereço de conexão REST do Kafka. |
public_boundwidth |
Integer |
Largura de banda de acesso à rede pública. A ser excluído. |
message_query_inst_enable |
Boolean |
Se a consulta de mensagens está ativada. |
vpc_client_plain |
Boolean |
Se o acesso de texto simples intra-VPC está ativado. |
support_features |
String |
Lista de recursos suportados pela instância de Kafka. |
trace_enable |
Boolean |
Se o rastreamento de mensagens está ativado. |
agent_enable |
Boolean |
Indica se o proxy está ativado. |
pod_connect_address |
String |
Endereço de conexão no lado do inquilino. |
disk_encrypted |
Boolean |
Se a encriptação de disco está ativada. |
disk_encrypted_key |
String |
Chave de encriptação do disco. Se a encriptação de disco não estiver activada, este parâmetro é deixado em branco. |
kafka_private_connect_address |
String |
Endereço de conexão privada de uma instância de Kafka. |
ces_version |
String |
Versão Cloud Eye. |
public_access_enabled |
String |
Hora em que o acesso público foi ativado para uma instância. O valor pode ser true, actived, closed, ou false. |
node_num |
Integer |
Quantidade de nó. |
enable_acl |
Boolean |
Indica se o controle de acesso está habilitado. |
new_spec_billing_enable |
Boolean |
Se o faturamento com base em novas especificações está ativado. |
broker_num |
Integer |
Quantidade do broker. |
tags |
Array of TagEntity objects |
Lista de tag. |
dr_enable |
Boolean |
Indica se o DR está ativado. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
key |
String |
Chave de etiqueta, que pode conter um máximo de 36 caracteres Unicode. A chave não pode ser deixada em branco ou ser uma string vazia. Não pode conter caracteres ASCII (0–31) não imprimíveis e os seguintes caracteres especiais: =*<>,|/ |
value |
String |
Valor de tag, que pode conter no máximo 43 caracteres Unicode. O valor não pode ser deixado em branco ou ser uma string vazia. Não pode conter caracteres ASCII (0–31) não imprimíveis e os seguintes caracteres especiais: =*<>,|/ |
Exemplos de solicitações
GET https://{endpoint}/v2/{project_id}/instances
Exemplo de respostas
Código de estado: 200
Todas as instâncias são listadas com êxito.
Comentários "instâncias" : [ { "name" : "kafka-2085975099", "engine" : "kafka", "port" : 9092, "status" : "RUNNING", "type" : "cluster", "specification" : "100MB", "engine_version" : "1.1.0", "connect_address" : "192.168.0.100,192.168.0.61,192.168.0.72", "instance_id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "resource_spec_code" : "dms.instance.kafka.cluster.c3.mini", "charging_mode" : 1, "vpc_id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "vpc_name" : "dms-test", "created_at" : "1585618587087", "product_id" : "00300-30308-0--0", "security_group_id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "security_group_name" : "Sys-default", "subnet_id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "available_zones" : [ "38b0f7a602344246bcb0da47b5d548e7" ], "user_id" : "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "user_name" : "paas_dms", "kafka_manager_user" : "root", "maintain_begin" : "02:00:00", "maintain_end" : "06:00:00", "enable_log_collection" : false, "storage_space" : 492, "total_storage_space" : 600, "used_storage_space" : 25, "partition_num" : "300", "enable_publicip" : false, "ssl_enable" : false, "management_connect_address" : "https://192.168.0.100:9999", "cross_vpc_info" : "{\"192.168.0.61\":{\"advertised_ip\":\"192.168.0.61\",\"port\":9011,\"port_id\":\"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"},\"192.168.0.72\":{\"advertised_ip\":\"192.168.0.72\",\"port\":9011,\"port_id\":\"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"},\"192.168.0.100\":{\"advertised_ip\":\"192.168.0.100\",\"port\":9011,\"port_id\":\"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"}}", "storage_resource_id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "storage_spec_code" : "dms.physical.storage.ultra", "service_type" : "advanced", "storage_type" : "hec", "enterprise_project_id" : "0", "is_logical_volume" : true, "extend_times" : 0, "retention_policy" : "produce_reject", "ipv6_enable" : false, "ipv6_connect_addresses" : [ ], "connector_enable" : false, "connector_id" : "", "rest_enable" : false, "rest_connect_address" : "", "kafka_public_status" : "closed", "public_boundwidth" : 0, "message_query_inst_enable" : true, "vpc_client_plain" : false, "support_features" : "kafka.new.pod.port,feature.physerver.kafka.topic.modify,feature.physerver.kafka.topic.accesspolicy,message_trace_enable,features.pod.token.access,feature.physerver.kafka.pulbic.dynamic,roma_app_enable,features.log.collection,auto_topic_switch,feature.physerver.kafka.user.manager", "trace_enable" : false, "agent_enable" : false, "pod_connect_address" : "100.86.75.15:9080,100.86.142.77:9080,100.86.250.167:9080", "disk_encrypted" : false, "kafka_private_connect_address" : "192.168.0.61:9092,192.168.0.100:9092,192.168.0.72:9092", "enable_auto_topic" : false, "ces_version" : "linux" } ], "instance_num" : 1 }
Códigos de status
Código de status |
Descrição |
---|---|
200 |
Todas as instâncias são listadas com êxito. |
Códigos de erro
Consulte Códigos de erro.