Estos contenidos se han traducido de forma automática para su comodidad, pero Huawei Cloud no garantiza la exactitud de estos. Para consultar los contenidos originales, acceda a la versión en inglés.

Centro de ayuda/ TaurusDB/ Referencia de la API/ Las API (recomendadas)/ HTAP (Edición estándar)/ Consulta de instancias HTAP

Actualización más reciente 2025-03-21 GMT+08:00

Ver PDF

Consulta de instancias HTAP

Función

Esta API se utiliza para consultar instancias de HTAP. Antes de invocar a esta API:

Aprender cómo autorizar y autenticarla.
Obtenga la región y el punto de conexión requeridos.

URI

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

**Tabla 1** Parámetros de URI
Parámetro	Obligatorio	Tipo	Descripción
project_id	Sí	String	ID de proyecto de un tenant en una región. Para obtener este valor, consulte Obtención de un ID de proyecto.
instance_id	Sí	String	ID de instancia de TaurusDB, que es compatible con el formato UUID.

Parámetros de solicitud

**Tabla 2** Parámetros de encabezado de solicitud
Parámetro	Obligatorio	Tipo	Descripción
X-Auth-Token	Sí	String	Token de usuario. Para obtener este valor, invoque a la API de IAM para obtener un token de usuario. El valor de X-Subject-Token en el encabezado de respuesta es el valor del token.
Content-Type	Sí	String	Tipo de contenido. Valor: application/json
X-Language	No	String	Tipo de idioma de solicitud. El valor predeterminado es en-us. Valores: en-us zh-cn

Parámetros de respuesta

Código de estado: 200

**Tabla 3** Parámetros del cuerpo de respuesta
Parámetro	Tipo	Descripción
total	Integer	Número de instancias de HTAP.
instances	Array of instances objects	Información de instancia de HTAP.
max_htap_instance_num_of_taurus	Integer	Número máximo de instancias de HTAP que se pueden crear.

**Tabla 4** instances
Parámetro	Tipo	Descripción
id	String	ID de instancia de HTAP, que es compatible con el formato UUID.
name	String	Nombre de instancia de HTAP.
engine_name	String	Nombre del motor de BD de HTAP.
engine_version	String	Versión del motor de BD de HTAP.
project_id	String	ID de proyecto de un tenant en una región.
instance_state	instance_state object	Información de estado de la instancia de HTAP.
create_at	Long	Hora en la que se creó la instancia de HTAP.
is_frozen	Boolean	Si la instancia de HTAP está congelada.
ha_mode	String	Modo de despliegue de instancia de HTAP.
pay_model	String	Modo de facturación. Solo se admite la facturación de pago por uso. 0: pago por uso 1: anual/mensual
order_id	String	ID de pedido para la suscripción anual/mensual.
alter_order_id	String	ID de pedido alternativo para la suscripción anual/mensual.
data_vip	String	Dirección IP privada.
readable_node_infos	Array of ReadableNodeInfos objects	Información de nodo legible.
proxy_ips	Array of strings	Dirección IP del proxy.
data_vip_v6	String	Dirección IPv6 privada.
port	Integer	Puerto de base de datos.
available_zones	Array of available_zones objects	Información de zona de disponibilidad.
current_actions	Array of QueryAction objects	Acciones de instancia.
volume_type	String	Tipo de almacenamiento.
server_type	String	Tipo de servidor.
enterprise_project_id	String	ID de proyecto de empresa. Este parámetro es obligatorio cuando el proyecto de empresa está habilitado.
dedicated_resource_id	String	ID de grupo de recursos dedicados. Este parámetro solo se muestra cuando el grupo de recursos dedicado está habilitado.
network	network object	Información de la red.
ch_master_node_id	String	ID del nodo primario de ClickHouse.
node_num	Integer	Número de nodos.

**Tabla 5** instance_state
Parámetro	Tipo	Descripción
instance_status	String	Estado de la instancia de HTAP.
create_fail_error_code	String	Código de error para error de creación de instancia HTAP.
fail_message	String	Mensaje de error para error de creación de instancia HTAP.
wait_restart_for_params	Boolean	Si se requiere un reinicio para las actualizaciones de parámetros.

**Tabla 6** ReadableNodeInfos
Parámetro	Tipo	Descripción
data_ip	String	Dirección IP del nodo legible.
node_id	String	ID del nodo legible.
node_name	String	Nombre del nodo legible.

**Tabla 7** available_zones
Parámetro	Tipo	Descripción
code	String	Código de zona de disponibilidad.
description	String	Descripción de zona de disponibilidad.
az_type	String	Tipo de zona de disponibilidad.

**Tabla 8** QueryAction
Parámetro	Tipo	Descripción
id	String	ID de la acción de instancia o de nodo.
action	String	Nombre de la acción de instancia o de nodo.
object_id	String	ID de objeto de la acción de instancia o de nodo.
type	String	Tipo de la acción de instancia o de nodo.
job_id	String	ID de tarea de la acción de instancia o de nodo.
status	String	Estado de la acción de instancia o de nodo. Valores enumerados: OK_TO_RUN DELETED
created_at	Long	Hora en la que se creó la acción de instancia o de nodo.
updated_at	Long	Hora en la que se actualizó la acción de instancia o de nodo.

**Tabla 9** network
Parámetro	Tipo	Descripción
vpc_id	String	ID de VPC.
sub_net_id	String	ID de subred.
security_group_id	String	ID del grupo de seguridad.

Código de estado: 400

**Tabla 10** Parámetros del cuerpo de respuesta
Parámetro	Tipo	Descripción
error_code	String	Código de error.
error_msg	String	Mensaje de error.

Código de estado: 500

**Tabla 11** Parámetros del cuerpo de respuesta
Parámetro	Tipo	Descripción
error_code	String	Código de error.
error_msg	String	Mensaje de error.

Ejemplo de la solicitud

Consulta de instancias HTAP de una instancia de TaurusDB

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

Ejemplo de la respuesta

Código de estado: 200

Operación exitosa.

{
  "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 estado

Para más detalles, véase Códigos de estado.

Código de error

Para más detalles, véase Códigos de error.

Tema principal: HTAP (Edición estándar)

Tema anterior: Consulta de especificaciones de una instancia de HTAP

Tema siguiente: Creación de una tarea de sincronización de datos para una instancia de StarRocks

Comentarios

¿Le pareció útil esta página?

Sí No

Deje algún comentario

Muchas gracias por sus comentarios. Seguiremos trabajando para mejorar la documentación.

El sistema está ocupado. Vuelva a intentarlo más tarde.

¿Cuáles de los siguientes problemas se presentaron?

Contenido diferente a la de la IU del producto

Descripciones poco claras

Falta de ejemplos o código

Pasos incorrectos

No puedo encontrar lo que necesito

Falta de prácticas recomendadas

Comentarios (opcional)

0/500

Seleccione al menos un tipo de problema e ingrese sus comentarios o sugerencias.

Ingrese 500 caracteres como máximo.

Enviar Cancelar