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 leve)/ Consulta de detalhes da instância

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

Ver PDF

Consulta de detalhes da instância

Função

Essa API é usada para consultar detalhes da instância. 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}/clickhouse/{clickhouse_instance_id}

**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.
clickhouse_instance_id	Sim	String	ID da instância do ClickHouse, 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.
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âmetro do corpo da resposta
Parâmetro	Tipo	Descrição
instance	instance object	Informações da instância de BD.

**Tabela 4** instance
Parâmetro	Tipo	Descrição
id	String	ID da instância.
name	String	Nome da instância.
project_id	String	ID do projeto de um locatário numa região.
public_ip	String	Endereço IP público.
can_enable_public_access	Boolean	Se a instância pode ser acessada de uma rede pública.
current_backup_node_id	String	ID do nó de backup.
cluster_mode	String	Modo de implementação. Valores: Single: nó único Ha: primário/em espera
status	String	Status da instância.
is_frozen	Integer	Se a instância está congelada. Valores: 0: não congelada 1: congelada
frozen_time	String	Tempo congelado.
db_user	String	Usuário padrão.
bak_period	String	Ciclo de backup.
bak_keep_day	Integer	Dias de retenção de backup.
bak_expected_start_time	String	Hora estimada de início do backup.
datastore_version_id	String	ID da versão do BD.
datastore_version	String	Versão de BD.
datastore_type	String	Mecanismo de BD.
create_at	Integer	Hora de criação da instância.
update_at	Integer	Hora de atualização da instância.
delete_at	Integer	Hora de exclusão da instância.
db_port	String	Porta do banco de dados. Intervalo de valores: 0–65535.
param_group	param_group object	Modelo de parâmetro.
actions	Array of ChQueryActionInfo objects	Ações de instância.
create_fail_error_code	String	Código de erro para uma falha de criação de instância.
groups	Array of groups objects	Grupos de instâncias.
ops_window	ops_window object	Janela de tempo de operação da instância.
tags_info	tags_info object	Tags de instância.
time_zone	String	Fuso horário.
backup_used_space	String	Espaço de backup usado.
az_mode	String	Tipo de AZ. Valores: single: AZ única double: várias AZs
master_az_code	String	AZ primária.
enterprise_project_id	String	ID do projeto empresarial.
port_info	port_info object	Informações da porta.
volume_code	String	Código de especificação do disco.
support_data_replication	Boolean	Se as réplicas são suportadas.
new_version_available	Boolean	Se há uma nova versão de BD disponível.
ssl_option	Boolean	Se deve ativar o SSL.
dedicated_resource_id	String	ID do pool de recursos dedicado.
pay_model	String	Método de pagamento. Valores: 0: pagamento por uso 1: anual/mensal

**Tabela 5** param_group
Parâmetro	Tipo	Descrição
id	String	ID do parâmetro.
name	String	Nome do parâmetro.

**Tabela 6** ChQueryActionInfo
Parâmetro	Tipo	Descrição
id	String	ID de ação da instância.
action	String	Nome da ação da instância.
object_id	String	ID do objeto da ação da instância.
type	String	Tipo de ação de instância.
job_id	String	ID da tarefa da ação da instância.
status	String	Status da ação da instância.
created_at	Integer	Hora em que uma ação de instância foi criada.
updated_at	Integer	Hora em que uma ação de instância foi atualizada.

**Tabela 7** groups
Parâmetro	Tipo	Descrição
id	String	ID do grupo.
name	String	Nome de grupo.
group_type_name	String	Nome do tipo de grupo de instâncias. Apenas clickhouse é suportado.
nodes	Array of ClickHouseNodeInfo objects	Informações do nó da instância.

**Tabela 8** ClickHouseNodeInfo
Parâmetro	Tipo	Descrição
id	String	ID do nó da instância.
name	String	Nome do nó da instância.
type	String	Tipo de nó de instância. Valores: master: nó primário slave: nó em espera
status	String	Status do nó da instância.
period	String	Período de assinatura do nó da instância.
volume	volume object	Informações de armazenamento do nó da instância.
cpu	String	Número de vCPUs do nó da instância.
mem	String	Tamanho da memória (GB) do nó da instância.
datastore	datastore object	Informações de armazenamento de dados.
priority	Integer	Prioridade do nó.
frozen_flag	Integer	Bandeira congelada. Valores: 0: não congelada 1: congelada
db_port	Integer	Porta do banco de dados. Intervalo de valores: 0–65535.
pay_model	String	Método de pagamento. Valores: 0: pagamento por uso 1: anual/mensal
order_id	String	ID de pedido anual/mensal.
traffic_ip	String	Endereço IP do plano de dados do nó.
traffic_ipv6	String	Endereço IPv6 do plano de dados do nó.
traffic_vip	String	Endereço IP virtual do plano de dados do nó.
traffic_vipv6	String	Endereço IPv6 virtual do plano de dados do nó.
az_code	String	AZ.
az_description	String	Descrição da AZ.
az_type	String	Tipo de AZ.
region	String	Região onde o nó está localizado.
create_at	Integer	Hora em que o nó foi criado.
update_at	Integer	Hora em que o nó foi atualizado.
flavor_id	String	ID de especificação do nó.
flavor_ref	String	Código de especificação do nó.
iass_flavor_ref	String	Código de especificação de IaaS.
max_connections	String	Número máximo de conexões de rede pública.
vpc_id	String	ID de VPC
subnet_id	String	ID da sub-rede.
need_restart	Boolean	Se uma reinicialização é necessária para a atualização de parâmetros.
sg_id	String	Grupo de segurança.

**Tabela 9** volume
Parâmetro	Tipo	Descrição
type	String	Tipo de armazenamento do nó da instância. Valores: SSD: I/O ultra-alta ESSD: SSD extremo
size	String	Espaço de armazenamento do nó da instância.
used	String	Espaço de armazenamento usado do nó da instância.
iops	Integer	IOPS de armazenamento do nó da instância.

**Tabela 10** datastore
Parâmetro	Tipo	Descrição
id	String	ID do mecanismo.
type	String	Tipo de mecanismo. Apenas click-house é suportado.
version	String	Versão do mecanismo.

**Tabela 11** ops_window
Parâmetro	Tipo	Descrição
period	String	Período da janela de tempo.
start_time	String	Hora de início da janela de tempo.
end_time	String	Hora de término da janela de tempo.

**Tabela 12** tags_info
Parâmetro	Tipo	Descrição
tags	Array of tags objects	Tags do usuário.
sys_tags	Array of sys_tags objects	Tags do sistema.

**Tabela 13** tags
Parâmetro	Tipo	Descrição
key	String	Chave da tag.
value	String	Valor da tag.

**Tabela 14** sys_tags
Parâmetro	Tipo	Descrição
key	String	Chave da tag.
value	String	Valor da tag.

**Tabela 15** port_info
Parâmetro	Tipo	Descrição
tep_port	Integer	Porta TEP. Intervalo de valores: 0–65535.
http_port	Integer	Porta HTTP. Intervalo de valores: 0–65535.
mysql_port	Integer	Porta MySQL. Intervalo de valores: 0–65535.
https_port	Integer	Porta HTTPS. Intervalo de valores: 0–65535.
tep_secure_port	Integer	Porta de segurança TEP. Intervalo de valores: 0–65535.

Código de status: 400

**Tabela 16** 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 17** 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 detalhes sobre uma instância do ClickHouse

GET https://{endpoint}/v3/23a50154cf494ec9ad6883979a12db0a/instances/fb632d1d531a4107804f0f082581810fin07/clickhouse/df3ae779e2ad4993a03ccd7a81240125in16

Exemplo de resposta

Código de status: 200

Bem-sucedido.

{
  "instance" : {
    "id" : "f8d286fa7db44f51aed30ed7eb6da007in16",
    "name" : "htap-1fb3",
    "project_id" : "23a50154cf494ec9ad6883979a12db0a",
    "public_ip" : "",
    "can_enable_public_access" : false,
    "current_backup_node_id" : null,
    "cluster_mode" : "Single",
    "status" : "normal",
    "is_frozen" : 0,
    "frozen_time" : null,
    "db_user" : null,
    "bak_period" : null,
    "bak_keep_day" : null,
    "bak_expected_start_time" : null,
    "datastore_version_id" : "6a9e233f-e7da-3e81-b12f-7a41a8689250",
    "datastore_version" : "1.23.3.24",
    "datastore_type" : "click-house",
    "create_at" : 1714099209183,
    "update_at" : 1714099209781,
    "delete_at" : null,
    "db_port" : "3306",
    "param_group" : {
      "id" : "1661d4eddd4444dd8447992e74fa3b3epr16",
      "name" : "Default-clickhouse"
    },
    "actions" : [ ],
    "create_fail_error_code" : "",
    "groups" : [ {
      "id" : "f3f95d4a837f42ee921760f3c7a0e730gr16",
      "name" : "htap-1fb3_shard01",
      "group_type_name" : "clickhouse",
      "nodes" : [ {
        "id" : "8f23427bf3764627bca1ee40e2364abfno16",
        "name" : "htap-1fb3_shard01_node01",
        "type" : "master",
        "status" : "normal",
        "period" : "null",
        "volume" : {
          "type" : "SSD",
          "size" : "50000000000"
        },
        "cpu" : "4",
        "mem" : "16",
        "datastore" : {
          "id" : "6a9e233f-e7da-3e81-b12f-7a41a8689250",
          "type" : "click-house",
          "version" : "1.23.3.24"
        },
        "priority" : 1,
        "frozen_flag" : 0,
        "db_port" : 3306,
        "pay_model" : "0",
        "order_id" : "",
        "traffic_ip" : "192.168.0.55",
        "traffic_ipv6" : "",
        "traffic_vip" : "",
        "traffic_vipv6" : "",
        "az_code" : "cn-southwest-244b",
        "az_description" : "AZ2",
        "az_type" : "Center",
        "region" : "cn-southwest-244",
        "create_at" : 1714099209183,
        "update_at" : 1714099209183,
        "flavor_id" : "b44cfde6-d250-313c-8d7a-cd216f071658",
        "flavor_ref" : "gaussdb.ch.xlarge.x86.4",
        "iass_flavor_ref" : "c3.xlarge.4",
        "max_connections" : "0",
        "vpc_id" : "134c4042-1a1f-4cb8-8258-219a2f6c0d4d",
        "subnet_id" : "072e022f-13aa-4c8f-8d64-492cfd123305",
        "need_restart" : false,
        "sg_id" : ""
      } ]
    } ],
    "ops_window" : {
      "period" : null,
      "start_time" : "18:00",
      "end_time" : "22:00"
    },
    "tags_info" : {
      "tags" : [ ],
      "sys_tags" : [ {
        "key" : "_sys_enterprise_project_id",
        "value" : "0"
      } ]
    },
    "time_zone" : "UTC+08:00",
    "backup_used_space" : null,
    "az_mode" : "single",
    "master_az_code" : null,
    "enterprise_project_id" : null,
    "port_info" : {
      "tep_port" : 9000,
      "http_port" : 8123,
      "mysql_port" : 3306,
      "https_port" : 8443,
      "tep_secure_port" : 9440
    },
    "volume_code" : "gaussdb.ch.evs.ultrahighio",
    "support_data_replication" : true,
    "new_version_available" : false,
    "ssl_option" : true,
    "dedicated_resource_id" : null,
    "pay_model" : null
  }
}

Código de status

Código de status	Descrição
200	Bem-sucedido.
400	Erro do cliente.
500	Erro no servidor.

Código de erro

Para obter detalhes, consulte Códigos de erro.

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

Tópico anterior: Exclusão de uma instância

Próximo tópico: Ampliação do espaço de armazenamento de uma instância

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.