Este conteúdo foi traduzido por máquina para sua conveniência e a Huawei Cloud não pode garantir que o conteúdo foi traduzido com precisão. Para exibir o conteúdo original, use o link no canto superior direito para mudar para a página em inglês.
Atualizado em 2024-09-10 GMT+08:00

Consulta de uma instância

Esta API está desatualizada e pode não ser mantida no futuro. Use a API descrita em Consulta a uma instância.

Função

Essa API é usada para consultar os detalhes sobre uma instância.

URI

GET /v1.0/{project_id}/instances/{instance_id}

Tabela 1 descreve os parâmetros.

Tabela 1 Parâmetros

Parâmetro

Tipo

Obrigatório

Descrição

project_id

String

Sim

Indica o ID de um projeto.

instance_id

String

Sim

Indica o ID da instância.

Solicitação

Parâmetros de solicitação

Nenhum.

Exemplos de solicitações

GET https://{dms_endpoint}/v1.0/{project_id}/instances/{instance_id}

Resposta

Parâmetros de resposta

Tabela 2 descreve os parâmetros.

Tabela 2 Parâmetros de resposta

Parâmetro

Tipo

Descrição

name

String

Indica o nome da instância.

engine

String

Indica o mecanismo de mensagens.

engine_version

String

Indica a versão do mecanismo de mensagens.

specification

String

Indica a especificação da instância.

storage_space

Integer

Indica o espaço de armazenamento da mensagem. Unidade: GB

partition_num

String

Indica o número total de partições em uma instância de Kafka.

used_storage_space

Integer

Indica o espaço de armazenamento de mensagens usado. Unidade: GB

connect_address

String

Indica o endereço IP de uma instância.

port

Integer

Indica o número da porta de uma instância.

status

String

Indica o status de uma instância. Para mais detalhes, consulte Status da instância.

instance_id

String

Indica o ID da instância.

resource_spec_code

String

Indica o identificador das especificações do recurso.

  • dms.instance.kafka.cluster.c3.mini: instância do Kafka, largura de banda de referência de 100 MB/s
  • dms.instance.kafka.cluster.c3.small.2: instância do Kafka, largura de banda de referência de 300 MB/s
  • dms.instance.kafka.cluster.c3.middle.2: instância do Kafka, largura de banda de referência de 600 MB/s
  • dms.instance.kafka.cluster.c3.high.2: instância do Kafka, largura de banda de referência de 1200 MB/s

type

String

Indica o tipo de instância. Valor: cluster

charging_mode

Integer

Indica o modo de cobrança. 1: modo de pagamento por uso; 0: cobrança anual/mensal.

vpc_id

String

Indica o ID de uma VPC.

vpc_name

String

Indica o nome de uma VPC.

created_at

String

Indica a hora em que uma instância é criada. A hora está no formato de carimbo de data/hora, ou seja, o deslocamento em milissegundos de 01/01/1970 00:00:00 UTC até a hora especificada.

product_id

String

Indica o ID do produto.

security_group_id

String

Indica o ID do grupo de segurança.

security_group_name

String

Indica o nome do grupo de segurança.

subnet_id

String

Indica o ID da sub-rede.

subnet_name

String

Indica o nome da sub-rede.

subnet_cidr

String

Indica o bloco CIDR da sub-rede.

available_zones

Array

Indica o ID da AZ à qual o nó da instância pertence. O ID da AZ é retornado.

user_id

String

Indica o ID do usuário.

user_name

String

Indica o nome de usuário.

access_user

String

Indica o nome de usuário de uma instância.

order_id

String

Indica o ID do pedido.

maintain_begin

String

Indica a hora em que uma janela de tempo de manutenção é iniciada.

Formato: HH:mm:ss

maintain_end

String

Indica a hora em que uma janela de tempo de manutenção termina.

Formato: HH:mm:ss

enable_publicip

Boolean

Indica se deve ativar o acesso público para uma instância.

  • true: ativar
  • false: desativar

management_connect_address

String

Indica o endereço de conexão do Kafka Manager de uma instância do Kafka.

ssl_enable

Boolean

Indica se a autenticação de segurança deve ser ativada.

  • true: ativar
  • false: desativar

enterprise_project_id

String

Indica o ID do projeto empresarial.

is_logical_volume

Boolean

Distingue instâncias anteriores de novas instâncias durante a expansão da capacidade da instância.

  • true: nova instância, que permite a expansão dinâmica da capacidade do disco sem reiniciar a instância.
  • false: instância anterior.

extend_times

Integer

Indica o número de vezes de expansão do disco. Se exceder 20, o disco não pode ser expandido.

enable_auto_topic

Boolean

Indica se a criação automática de tópicos está ativada.

  • true: ativado
  • false: desativado

total_storage_space

Integer

Indica o espaço de armazenamento da mensagem. Unidade: GB

storage_resource_id

String

Indica o ID do recurso de armazenamento.

storage_spec_code

String

Indica a especificação de I/O.

service_type

String

Indica o tipo de serviço.

storage_type

String

Indica o tipo de armazenamento.

retention_policy

String

Indica a política de retenção de mensagens.

kafka_public_status

String

Indica se o acesso público do Kafka está ativado.

public_bandwidth

Integer

Indica a largura de banda da rede pública.

public_connect_address

String

Indica o endereço IP da instância para acesso público. Esse parâmetro é exibido somente quando o acesso público está ativado.

kafka_manager_user

String

Indica o nome de usuário para fazer logon no Kafka Manager.

enable_log_collection

Boolean

Indica se a coleta de log está ativada.

cross_vpc_info

String

Indica informações de acesso entre VPCs.

ipv6_enable

Boolean

Indica se o IPv6 está ativado.

ipv6_connect_addresses

Array of strings

Indica o endereço de conexão IPv6.

rest_enable

Boolean

Indica se a função REST do Kafka está ativada.

rest_connect_address

String

Indica o endereço de conexão REST do Kafka.

message_query_inst_enable

Boolean

Indica se a consulta de mensagens está ativada.

vpc_client_plain

Boolean

Indica se o acesso de texto não criptografado dentro da VPC está ativado.

support_features

String

Indica a lista de recursos suportados pela instância de Kafka.

trace_enable

Boolean

Indica se o rastreamento de mensagens está ativado.

pod_connect_address

String

Indica o endereço de conexão no lado do locatário.

disk_encrypted

Boolean

Indica se a criptografia de disco está ativada.

  • true: ativado
  • false: desativado

kafka_private_connect_address

String

Indica o endereço de conexão privada de uma instância do Kafka.

ces_version

String

Indica a versão do Cloud Eye.

tags

Array<Object>

Indica a lista de tags.

Tabela 3 tags

Parâmetro

Tipo

Descrição

key

String

Indica a chave da tag.

value

String

Indica o valor da tag.

Exemplo de respostas

{
    "name": "kafka-l00230526",
    "engine": "kafka",
    "port": 9092,
    "status": "RUNNING",
    "type": "cluster",
    "specification": "100MB",
    "engine_version": "XXX",
    "connect_address": "192.168.1.116,192.168.1.152,192.168.1.78",
    "connect_dn": "",
    "instance_id": "ef84dd5f-3ece-4336-8c99-987defd62e3a",
    "resource_spec_code": "dms.instance.kafka.cluster.c3.mini",
    "charging_mode": 1,
    "vpc_id": "2477879f-aebf-496f-a08a-67812885ce9b",
    "vpc_name": "vpc-y00502467",
    "created_at": "1568797295209",
    "product_id": "00300-30308-0--0",
    "security_group_id": "008a08e2-10cc-4d9b-90ab-3f3b8f6c3333",
    "security_group_name": "z00417080-cce-node-na7j",
    "subnet_id": "5ca08fb7-7522-4d95-9fa5-ff6b3592a29d",
    "subnet_name": "subnet-cyd-6102",
    "subnet_cidr": "192.168.1.0/24",
    "available_zones": [
        "ae04cf9d61544df3806a3feeb401b204"
    ],
    "user_id": "2b4af4428ec840dfa1f0f1a32e965567",
    "user_name": "laiyh",
    "kafka_manager_user": "root",
    "maintain_begin": "22:00:00",
    "maintain_end": "02:00:00",
    "storage_space": 492,
    "total_storage_space": 600,
    "used_storage_space": 25,
    "partition_num": "300",
    "ssl_enable": false,
    "management_connect_address": "https://192.168.1.116:9999",
    "storage_resource_id": "81982562-ce8b-490a-95fa-2b225c292271",
    "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": "",
    "message_query_inst_enable": true,
    "vpc_client_plain": false,
    "support_features": "feature.physerver.kafka.topic.accesspolicy,message_trace_enable,features.pod.token.access,feature.physerver.kafka.pulbic.dynamic,feature.physerver.kafka.user.manager",
    "trace_enable": false,
    "agent_enable": false,
    "pod_connect_address": "100.113.16.105:9100,100.113.5.197:9100,100.113.15.231:9100",
    "disk_encrypted": false,
    "enable_auto_topic": true
}

Código de status

Tabela 4 descreve o código de status das operações bem-sucedidas. Para obter detalhes sobre outros códigos de status, consulte Código de status.

Tabela 4 Código de status

Código de status

Descrição

200

A instância especificada foi consultada com sucesso.