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.

Central de ajuda/ TaurusDB/ Referência de API/ APIs (recomendadas)/ HTAP (edição padrão)/ Consulta de instâncias de HTAP

Atualizado em 2025-05-23 GMT+08:00

Ver PDF

Consulta de instâncias de HTAP

Função

Essa API é usada para consultar instâncias de HTAP. Antes de chamar essa API:

Saiba como autorizá-la e autenticá-la.
Obtenha a região e o ponto de extremidade necessários.

URI

GET /v3/{project_id}/instances/{instance_id}/htap

**Tabela 1** Parâmetros de URI
Parâmetro	Obrigatório	Tipo	Descrição
project_id	Sim	String	ID do projeto de um locatário numa região. Para obter esse valor, consulte Obtenção de um ID de projeto.
instance_id	Sim	String	ID da instância do TaurusDB, que é compatível com o formato UUID.

Parâmetros de solicitação

**Tabela 2** Parâmetros de cabeçalho de solicitação
Parâmetro	Obrigatório	Tipo	Descrição
X-Auth-Token	Sim	String	Token do usuário. Para obter esse valor, chame a API do IAM para obter um token de usuário. O valor de X-Subject-Token no cabeçalho da resposta é o valor do token.
Content-Type	Sim	String	Tipo de conteúdo. Valor: application/json
X-Language	Não	String	Tipo de linguagem da solicitação. O valor padrão é en-us. Valores: en-us zh-cn

Parâmetros de resposta

Código de status: 200

**Tabela 3** Parâmetros do corpo de resposta
Parâmetro	Tipo	Descrição
total	Integer	Número de instâncias de HTAP.
instances	Array of instances objects	Informações da instância de HTAP.
max_htap_instance_num_of_taurus	Integer	Número máximo de instâncias de HTAP que podem ser criadas.

**Tabela 4** Instâncias
Parâmetro	Tipo	Descrição
id	String	ID da instância de HTAP, que é compatível com o formato UUID.
name	String	Nome da instância de HTAP.
engine_name	String	Nome do mecanismo de BD HTAP.
engine_version	String	Versão do mecanismo de BD HTAP.
project_id	String	ID do projeto de um locatário numa região.
instance_state	instance_state object	Informações de status da instância de HTAP.
create_at	Long	Hora em que a instância de HTAP foi criada.
is_frozen	Boolean	Se a instância de HTAP está congelada.
ha_mode	String	Modo de implementação da instância de HTAP.
pay_model	String	Modo de cobrança. Apenas a cobrança paga por uso é suportada. 0: pagamento por uso 1: anual/mensal
order_id	String	ID do pedido para a assinatura anual/mensal.
alter_order_id	String	ID de pedido alternativo para a assinatura anual/mensal.
data_vip	String	Endereço IP privado.
readable_node_infos	Array of ReadableNodeInfos objects	Informações de nó legíveis.
proxy_ips	Array of strings	Endereço IP do proxy.
data_vip_v6	String	Endereço IPv6 privado.
port	Integer	Porta do banco de dados.
available_zones	Array of available_zones objects	Informações da AZ.
current_actions	Array of QueryAction objects	Ações de instância.
volume_type	String	Tipo de armazenamento.
server_type	String	Tipo de servidores.
enterprise_project_id	String	ID do projeto empresarial. Este parâmetro é obrigatório quando o projeto empresarial está ativado.
dedicated_resource_id	String	ID do pool de recursos dedicado. Esse parâmetro é exibido somente quando o pool de recursos dedicado está ativado.
network	network object	Informações de rede.
ch_master_node_id	String	ID do nó primário do ClickHouse.
node_num	Integer	Número de nós.

**Tabela 5** instance_state
Parâmetro	Tipo	Descrição
instance_status	String	Status da instância de HTAP.
create_fail_error_code	String	Código de erro para falha na criação da instância de HTAP.
fail_message	String	Mensagem de erro para falha na criação da instância de HTAP.
wait_restart_for_params	Boolean	Se uma reinicialização é necessária para atualizações de parâmetros.

**Tabela 6** ReadableNodeInfos
Parâmetro	Tipo	Descrição
data_ip	String	Endereço IP do nó legível.
node_id	String	ID do nó legível.
node_name	String	Nome do nó legível.

**Tabela 7** available_zones
Parâmetro	Tipo	Descrição
code	String	Código de AZ.
description	String	Descrição da AZ.
az_type	String	Tipo de AZ.

**Tabela 8** QueryAction
Parâmetro	Tipo	Descrição
id	String	ID de ação da instância ou do nó.
action	String	Nome da ação da instância ou do nó.
object_id	String	ID do objeto da instância ou ação de nó.
type	String	Tipo de ação de instância ou nó.
job_id	String	ID da tarefa da instância ou ação do nó.
status	String	Status da ação da instância ou do nó. Valores enumerados: OK_TO_RUN DELETED
created_at	Long	Hora em que a instância ou a ação de nó foi criada.
updated_at	Long	Hora em que a instância ou a ação do nó foi atualizada.

**Tabela 9** network
Parâmetro	Tipo	Descrição
vpc_id	String	ID de VPC
sub_net_id	String	ID da sub-rede.
security_group_id	String	ID do grupo de segurança.

Código de status: 400

**Tabela 10** Parâmetros do corpo de resposta
Parâmetro	Tipo	Descrição
error_code	String	Código de erro.
error_msg	String	Mensagem de erro.

Código de status: 500

**Tabela 11** Parâmetros do corpo de resposta
Parâmetro	Tipo	Descrição
error_code	String	Código de erro.
error_msg	String	Mensagem de erro.

Exemplo de solicitação

Consulta de instâncias de HTAP de uma instância do TaurusDB

GET https://{endpoint}/v3/23a50154cf494ec9ad6883979a12db0a/instances/18c3eeb7b788479eb8b93b209946a83bin07/htap

Exemplo de resposta

Código de status: 200

Bem-sucedido.

{
  "total" : 4,
  "instances" : [ {
    "id" : "bfc970d8e9b34a399b4c422aabe11409in17",
    "name" : "htap-fjld",
    "engine_name" : "star-rocks",
    "engine_version" : "3.1.6",
    "project_id" : "23a50154cf494ec9ad6883979a12db0a",
    "instance_state" : {
      "instance_status" : "normal",
      "create_fail_error_code" : null,
      "fail_message" : null,
      "wait_restart_for_params" : false
    },
    "create_at" : 1711094408228,
    "is_frozen" : false,
    "ha_mode" : "Single",
    "pay_model" : "0",
    "order_id" : null,
    "alter_order_id" : "",
    "data_vip" : "192.168.0.207",
    "data_ips" : {
      "node_ip" : "192.168.0.207",
      "node_id" : "36d62cd6a77a4e80a335077867e7912bno16",
      "node_name" : "htap-1244_shard01_node01"
    },
    "proxy_ips" : [ ],
    "data_vip_v6" : null,
    "port" : 3306,
    "available_zones" : [ {
      "code" : "cn-southwest-244b",
      "description" : "az2",
      "az_type" : "Center"
    } ],
    "current_actions" : [ ],
    "volume_type" : "SSD",
    "server_type" : "KVM",
    "enter_prise_project_id" : "0",
    "dedicated_resource_id" : "",
    "network" : {
      "vpc_id" : "f7876b94-3696-419b-a609-161de4b42d59",
      "sub_net_id" : "8926baca-467a-4556-8603-b4077805ff9d",
      "security_group_id" : ""
    },
    "ch_master_node_id" : null,
    "node_num" : 2
  }, {
    "id" : "656c539296bd47b49fe29983368b9fb2in17",
    "name" : "HTAP-1711093893",
    "engine_name" : "star-rocks",
    "engine_version" : "3.1.6",
    "project_id" : "23a50154cf494ec9ad6883979a12db0a",
    "instance_state" : {
      "instance_status" : "normal",
      "create_fail_error_code" : null,
      "fail_message" : null,
      "wait_restart_for_params" : false
    },
    "create_at" : 1711094228737,
    "is_frozen" : false,
    "ha_mode" : "Single",
    "pay_model" : "0",
    "order_id" : null,
    "alter_order_id" : "",
    "data_vip" : "192.168.0.201",
    "data_ips" : [ "192.168.0.201" ],
    "proxy_ips" : [ ],
    "data_vip_v6" : null,
    "port" : 3306,
    "available_zones" : [ {
      "code" : "az",
      "description" : "az2",
      "az_type" : "Center"
    } ],
    "current_actions" : [ ],
    "volume_type" : "SSD",
    "server_type" : "KVM",
    "enter_prise_project_id" : "0",
    "dedicated_resource_id" : "",
    "network" : {
      "vpc_id" : "f7876b94-3696-419b-a609-161de4b42d59",
      "sub_net_id" : "8926baca-467a-4556-8603-b4077805ff9d",
      "security_group_id" : ""
    },
    "ch_master_node_id" : null,
    "node_num" : 2
  }, {
    "id" : "04c48d11f0d24c8d8aee254981a3b94fin17",
    "name" : "htap-fjlc",
    "engine_name" : "star-rocks",
    "engine_version" : "3.1.6",
    "project_id" : "23a50154cf494ec9ad6883979a12db0a",
    "instance_state" : {
      "instance_status" : "normal",
      "create_fail_error_code" : null,
      "fail_message" : null,
      "wait_restart_for_params" : false
    },
    "create_at" : 1711075260516,
    "is_frozen" : false,
    "ha_mode" : "Cluster",
    "pay_model" : "0",
    "order_id" : null,
    "alter_order_id" : "",
    "data_vip" : "192.168.0.249",
    "data_ips" : [ "192.168.0.183", "192.168.0.7", "192.168.0.41" ],
    "proxy_ips" : [ ],
    "data_vip_v6" : null,
    "port" : 3306,
    "available_zones" : [ {
      "code" : "az",
      "description" : "az2",
      "az_type" : "Center"
    } ],
    "current_actions" : [ ],
    "volume_type" : "SSD",
    "server_type" : "KVM",
    "enter_prise_project_id" : "0",
    "dedicated_resource_id" : "",
    "network" : {
      "vpc_id" : "f7876b94-3696-419b-a609-161de4b42d59",
      "sub_net_id" : "8926baca-467a-4556-8603-b4077805ff9d",
      "security_group_id" : ""
    },
    "ch_master_node_id" : null,
    "node_num" : 6
  }, {
    "id" : "f2d2441a88384023b2e30f0b600a0013in17",
    "name" : "htap-fjlb",
    "engine_name" : "star-rocks",
    "engine_version" : "3.1.6",
    "project_id" : "23a50154cf494ec9ad6883979a12db0a",
    "instance_state" : {
      "instance_status" : "normal",
      "create_fail_error_code" : null,
      "fail_message" : null,
      "wait_restart_for_params" : false
    },
    "create_at" : 1711021269903,
    "is_frozen" : false,
    "ha_mode" : "Single",
    "pay_model" : "0",
    "order_id" : null,
    "alter_order_id" : "",
    "data_vip" : "192.168.0.209",
    "data_ips" : [ "192.168.0.151", "192.168.0.209" ],
    "proxy_ips" : [ ],
    "data_vip_v6" : null,
    "port" : 3306,
    "available_zones" : [ {
      "code" : "cn-southwest-244b",
      "description" : "az2",
      "az_type" : "Center"
    } ],
    "current_actions" : [ ],
    "volume_type" : "SSD",
    "server_type" : "KVM",
    "enter_prise_project_id" : "0",
    "dedicated_resource_id" : "",
    "network" : {
      "vpc_id" : "f7876b94-3696-419b-a609-161de4b42d59",
      "sub_net_id" : "8926baca-467a-4556-8603-b4077805ff9d",
      "security_group_id" : ""
    },
    "ch_master_node_id" : null,
    "node_num" : 2
  } ],
  "max_htap_instance_num_of_taurus" : 10
}

Código de status

Para mais detalhes, consulte Códigos de status.

Código de erro

Para mais detalhes, consulte Códigos de erro.

Tópico principal: HTAP (edição padrão)

Tópico anterior: Consulta de especificações de uma instância de HTAP

Próximo tópico: Criação de uma tarefa de sincronização de dados para uma instância do StarRocks

Feedback

Esta página foi útil?

Sim Não

Deixar um comentário

Obrigado por seus comentários. Estamos trabalhando para melhorar a documentação.

O sistema está ocupado. Tente novamente mais tarde.

Quais dos seguintes problemas você encontrou?

O conteúdo é inconsistente com a UI do produto

Descrições pouco claras

Falta de exemplos ou código

Passos incorretos

Não encontro o que preciso

Falta de melhores práticas

Feedback (opcional)

0/500

Selecione pelo menos um tipo de problema e insira seus comentários ou sugestões.

Insira um máximo de 500 caracteres.

Enviar Cancelar