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)/ Proxy de base de datos/ Consulta de instancias proxy
Actualización más reciente 2025-03-21 GMT+08:00
Ver PDF
Compartir

Consulta de instancias proxy

Función

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

URI

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

Tabla 1 Parámetros de URI

Parámetro

Obligatorio

Tipo

Descripción

project_id

Sí

String

Explicación:

ID de proyecto de un tenant en una región.

Para obtener este valor, vea Obtención de un ID de proyecto.

Restricciones:

Ninguna

Rango de valor:

El valor puede contener 32 caracteres. Solo se permiten letras y dígitos.

Valor predeterminado:

Ninguno

instance_id

Sí

String

Explicación:

ID de instancia, que identifica de forma única una instancia.

Restricciones:

Ninguna

Rango de valor:

El valor puede contener 36 caracteres con el sufijo de in07. Solo se permiten letras y dígitos.

Valor predeterminado:

Ninguno
Tabla 2 Parámetros de consulta

Parámetro

Obligatorio

Tipo

Descripción

offset

No

Integer

Explicación:

Desplazamiento de índice. La consulta comienza a partir de la siguiente pieza de datos indexada por este parámetro.

Restricciones:

El valor debe ser un número entero y no puede ser un número negativo.

Rango de valor:

≥0

Valor predeterminado:

0

limit

No

Integer

Explicación:

Número de registros a consultar.

Restricciones:

El valor debe ser un número entero y no puede ser un número negativo.

Rango de valor:

1–100

Valor predeterminado:

100

Parámetros de solicitud

Tabla 3 Parámetros de encabezado de solicitud

Parámetro

Obligatorio

Tipo

Descripción

X-Auth-Token

Sí

String

Explicación:

Token de usuario.

Se puede obtener invocando a la API de IAM utilizada para obtener un token de usuario.

El valor de X-Subject-Token en el encabezado de respuesta es el valor del token.

Restricciones:

Ninguna

Rango de valor:

Ninguna

Valor predeterminado:

Ninguna

X-Language

No

String

Explicación:

Tipo de idioma de solicitud.

Restricciones:

Ninguna

Rango de valor:

  • en-us
  • zh-cn

Valor predeterminado:

en-us

Parámetros de respuesta

Código de estado: 200

Tabla 4 Parámetros de cuerpo de respuesta

Parámetro

Tipo

Descripción

proxy_list

Array of MysqlShowProxyResponseV3 objects

Explicación:

Instancias de proxy.
Tabla 5 MysqlShowProxyResponseV3

Parámetro

Tipo

Descripción

proxy

MysqlProxyV3 object

Explicación:

Información de instancia proxy.

master_node

MysqlProxyNodeV3 object

Explicación:

Información del nodo primario.

readonly_nodes

Array of MysqlProxyNodeV3 objects

Explicación:

Información de réplica de lectura.
Tabla 6 MysqlProxyV3

Parámetro

Tipo

Descripción

pool_id

String

Explicación:

ID de instancia proxy.

Rango de valor:

El valor puede contener 36 caracteres con el sufijo de po01. Solo se permiten letras y dígitos.

status

String

Explicación:

Estado de una instancia proxy.

Rango de valor:

  • ACTIVE: La instancia proxy es normal.
  • FAILED: Error al crear la instancia proxy.
  • DELETED: Se suprime la instancia proxy.
  • ABNORMAL: La instancia proxy es anormal.
  • ENABLING PROXY: Se está creando la instancia proxy.
  • DISABLING PROXY: Se está eliminando la instancia proxy.
  • ADDING PROXY NODE: Se están agregando nodos a la instancia proxy.
  • DELETING READ REPLICAS FROM PROXY: Las réplicas de lectura se están eliminando de la instancia proxy.
  • ADDING READ REPLICAS TO PROXY: Se están agregando réplicas de lectura a la instancia proxy.
  • CHANGING WEIGHTS: Se están cambiando las ponderaciones de las réplicas de lectura para la instancia proxy.

address

String

Explicación:

Dirección IP proxy.

Rango de valor:

Ninguno

port

Integer

Explicación:

Puerto de una instancia proxy.

Rango de valor:

Ninguno

pool_status

String

Explicación:

Estado de una instancia proxy.

Rango de valor:

  • ACTIVE: La instancia proxy es normal.
  • ABNORMAL: La instancia proxy es anormal.
  • FAILED: Error al crear la instancia proxy.
  • DELETED: Se suprime la instancia proxy.

delay_threshold_in_seconds

Integer

Explicación:

Umbral de retardo en segundos.

Rango de valor:

Ninguno

elb_vip

String

Explicación:

Dirección IP virtual en modo ELB.

Rango de valor:

Ninguno

eip

String

Explicación:

EIP.

Rango de valor:

Ninguno

vcpus

String

Explicación:

vCPU de una instancia proxy.

Rango de valor:

Ninguno

ram

String

Explicación:

Tamaño de memoria de una instancia proxy.

Rango de valor:

Ninguno

node_num

Integer

Explicación:

Número de nodos de instancia proxy.

Rango de valor:

Ninguno

mode

String

Explicación:

Modo de instancia proxy.

Rango de valor:

Clúster

nodes

Array of MysqlProxyNodes objects

Explicación:

Nodos proxy de base de datos.

flavor_ref

String

Explicación:

Especificaciones de instancia proxy.

Rango de valor:

Ninguno

name

String

Explicación:

Nombre de instancia de proxy.

Rango de valor:

Ninguno

transaction_split

String

Explicación:

Estado de división de transacciones para la instancia proxy.

Rango de valor:

  • true: habilitado
  • false: deshabilitado

connection_pool_type

String

Explicación:

Tipo de grupo de conexión.

Rango de valor:

  • CLOSED: El grupo de conexión está cerrado.
  • SESSION: El grupo de conexión de nivel de sesión está habilitado.

switch_connection_pool_type_enabled

Boolean

Explicación:

Si la versión de instancia proxy admite grupo de conexión de nivel de sesión.

Rango de valor:

  • true:: admitido
  • false: no admitido

route_mode

Integer

Explicación:

Política de enrutamiento de la instancia proxy.

Rango de valor:

  • 0: ponderado
  • 1: balanceo de carga (El nodo primario no procesa las solicitudes de lectura).
  • 2: balanceo de carga (El nodo primario procesa las solicitudes de lectura).

balance_route_mode_enabled

Boolean

Explicación:

Si la versión de instancia proxy admite balanceo de carga.

Rango de valor:

  • true:: admitido
  • false: no admitido

consistence_mode

String

Explicación:

Nivel de consistencia. El parámetro se deja en blanco por defecto.

Rango de valor:

  • session: coherencia de sesión (Solo se puede utilizar este valor cuando session_consistence es true.)
  • global: consistencia global (Este valor se puede utilizar cuando session_consistence es false.)
  • eventual: consistencia eventual (Este valor se puede utilizar cuando session_consistence es false.)

subnet_id

String

Explicación:

ID de la subred a la que pertenece la instancia proxy.

Rango de valor:

Ninguno

ssl_option

String

Explicación:

Si se debe habilitar SSL.

Rango de valor:

  • true: SSL está habilitado.
  • false: SSL está deshabilitado.

new_node_auto_add_status

String

Explicación:

Si los nuevos nodos se asocian automáticamente con instancias proxy.

Rango de valor:

  • ON: Los nuevos nodos se asocian automáticamente con las instancias proxy.
  • OFF: Los nuevos nodos no se asocian automáticamente con instancias proxy.

new_node_weight

Integer

Explicación:

Ponderación de lectura de un nuevo nodo.

Rango de valor:

1–1000
Tabla 7 MysqlProxyNodes

Parámetro

Tipo

Descripción

id

String

Explicación:

ID de nodo de proxy.

status

String

Explicación:

Estado del nodo de instancia proxy.

Rango de valor:

  • ACTIVE: El nodo es normal.
  • ABNORMAL: El nodo es anormal.
  • FAILED: El nodo falla.
  • DELETED: Se ha eliminado el nodo.

name

String

Explicación:

Nombre del nodo de instancia proxy.

Rango de valor:

Ninguno

role

String

Explicación:

Rol del nodo de instancia proxy.

Rango de valor:

  • master: nodo primario
  • slave: lectura de réplica

az_code

String

Descripción

Zona de disponibilidad.

Rango de valor:

Ninguno

frozen_flag

Integer

Explicación:

Si el nodo de instancia proxy está suspendido.

Rango de valor:

  • 0: descongelado
  • 1: congelado
  • 2: eliminado después de ser congelado
Tabla 8 MysqlProxyNodeV3

Parámetro

Tipo

Descripción

id

String

Explicación:

ID del nodo de instancia proxy.

Rango de valor:

El valor puede contener 36 caracteres con el sufijo de no07. Solo se permiten letras y dígitos.

instance_id

String

Explicación:

ID de instancia, que identifica de forma única una instancia.

Rango de valor:

El valor puede contener 36 caracteres con el sufijo de in07. Solo se permiten letras y dígitos.

status

String

Explicación:

Estado del nodo.

Rango de valor:

  • ACTIVE: El nodo es normal.
  • ABNORMAL: El nodo es anormal.
  • FAILED: El nodo falla.
  • DELETED: Se ha eliminado el nodo.

name

String

Explicación:

Nombre del nodo.

Rango de valor:

Ninguno

weight

Integer

Explicación:

Ponderación de lectura del nodo.

Rango de valor:

1–1000

availability_zone

Array of MysqlProxyAvailable objects

Explicación:

Información de zona de disponibilidad.
Tabla 9 MysqlProxyAvailable

Parámetro

Tipo

Descripción

code

String

Explicación:

Código de zona de disponibilidad.

Rango de valor:

Ninguno

description

String

Explicación:

Descripción de zona de disponibilidad.

Rango de valor:

Ninguno

Código de estado: 400

Tabla 10 Parámetros de 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 de cuerpo de respuesta

Parámetro

Tipo

Descripción

error_code

String

Código de error.

error_msg

String

Mensaje de error.

Solicitud de ejemplo

Consulta de instancias proxy

GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/096c0fc43e804757b59946b80dc27f8bin07/proxies?offset=0&limit=10

Ejemplo de respuesta

Código de estado: 200

Operación exitosa.

{
  "proxy_list" : [ {
    "proxy" : {
      "pool_id" : "2e7cf21d14794bafab623a334efd9ad8po01",
      "status" : "ACTIVE",
      "address" : "192.168.125.69",
      "port" : 3306,
      "pool_status" : "ACTIVE",
      "delay_threshold_in_seconds" : 30,
      "elb_vip" : "192.168.125.60",
      "eip" : "192.168.125.50",
      "vcpus" : 4,
      "ram" : 8,
      "node_num" : 2,
      "mode" : "Cluster",
      "nodes" : [ {
        "id" : "db53a238a02240c49365e72e284a4890pn01",
        "name" : "PROXY-2e7cf21d14794bafab623a334efd9ad8po01_0",
        "role" : "master",
        "az_code" : "az1xahz",
        "status" : "ACTIVE",
        "frozen_flag" : 0
      } ],
      "name" : "proxy-name",
    
      "connection_pool_type" : "SESSION", 
      "switch_connection_pool_type_enabled" : true ,
      "subnet_id" : "6991d82d-9166-4aff-a1fa-d2a8748b7084"
    },
    "master_node" : {
      "id" : "c01a5645eb2c4fb6a9373542f5366e50no07",
      "instance_id" : "7a871d6d494e4327ad2e326afb591108in07",
      "status" : "ACTIVE",
      "name" : "taurus_mysql80_x86-ondemand-2-1U4G_1_202103070251274842281_node01",
      "weight" : 0,
      "availability_zone" : [{
        "code" : "az1",
        "description": "AZ1"
      }]
    },
    "readonly_nodes" : {
      "id" : "d23535333138462880bfa1838fdfced2no07",
      "instance_id" : "7a871d6d494e4327ad2e326afb591108in07",
      "status" : "ACTIVE",
      "name" : "taurus_mysql80_x86-ondemand-2-1U4G_1_202103070251274842281_node02",
      "weight" : 100,
      "availability_zone" : [{
        "code" : "az1",
        "description": "AZ1"
      }]
    }
  } ]
}

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: Proxy de base de datos