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/ API Gateway/ Referencia de la API/ API de gateway dedicados (V2)/ Gestión de canales de VPC/ Consulta de servidores de backend de un canal de VPC
Actualización más reciente 2025-12-22 GMT+08:00
Ver PDF
Compartir

Consulta de servidores de backend de un canal de VPC

Función

Esta API se utiliza para consultar las instancias de backend de un canal de VPC especificado.

Método de invocación

Para obtener más información, véase invocación de API.

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vpc_channel_id}/members

Tabla 1 Parámetros de ruta

Parámetro

Obligatorio

Tipo

Descripción

project_id

Sí

String

ID del proyecto. Para obtener más información sobre cómo obtenerlo, véase Obtención de un ID de proyecto.

instance_id

Sí

String

ID de gateway, que se puede obtener de la información de gateway en la consola de APIG.

vpc_channel_id

Sí

String

ID de canal de VPC.
Tabla 2 Parámetros de consulta

Parámetro

Obligatorio

Tipo

Descripción

offset

No

Long

Desfase desde el que se inicia la consulta. Si el valor es menor que 0, se convierte automáticamente a 0.

Predeterminado: 0

limit

No

Integer

Número de elementos mostrados en cada página. Un valor menor o igual a 0 se convertirá automáticamente a 20, y un valor mayor que 500 se convertirá automáticamente a 500.

Mínimo: 1

Máximo: 500

Predeterminado: 20

name

No

String

Nombre del servidor en la nube.

member_group_name

No

String

Nombre del grupo de servidores backend.

member_group_id

No

String

ID de grupo de servidor de backend.

precise_search

No

String

Nombre del parámetro para la coincidencia exacta. Separar varios nombres de parámetros con comas (,).

Actualmente, se admiten nombre y member_group_name.

Parámetros de solicitud

Tabla 3 Parámetros de encabezado de solicitud

Parámetro

Obligatorio

Tipo

Descripción

X-Auth-Token

Sí

String

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 un token.

Parámetros de respuesta

Código de estado: 200

Tabla 4 Parámetros del cuerpo de respuesta

Parámetro

Tipo

Descripción

size

Integer

Longitud de la lista de recursos devuelta.

total

Long

Número de recursos que coinciden con las condiciones de consulta.

members

Array of VpcMemberInfo objects

Lista de servidores en la nube.
Tabla 5 VpcMemberInfo

Parámetro

Tipo

Descripción

host

String

Dirección del servidor backend.

Este parámetro es necesario cuando el tipo de miembro es dirección IP.

Máximo: 255

weight

Integer

Ponderación.

Cuanto mayor sea la ponderación, más solicitudes recibirá un servicio de backend.

Mínimo: 0

Máximo: 10000

is_backup

Boolean

Indica si el servicio backend es un nodo en espera.

Después de habilitar esta opción, el servicio de backend correspondiente actúa como nodo en espera y funciona solo cuando todos los nodos que no son en espera presentan fallas.

Esta función solo se admite cuando el gateway se ha actualizado a la versión correspondiente. Si su gateway no admite esta función, póngase en contacto con el soporte técnico.

Predeterminado: false

member_group_name

String

Nombre del grupo de servidores backend. El grupo de servidores facilita la modificación de la dirección del servicio de backend.

status

Integer

Estado del servidor backend.

  • 1: disponible

  • 2: no disponible

port

Integer

Puerto de servidor de backend.

Mínimo: 0

Máximo: 65535

ecs_id

String

ID del servidor de backend.

Este parámetro es necesario si el tipo de instancia de backend es ecs. El valor puede contener de 1 a 64 caracteres, incluidos letras, dígitos, guiones (-) y guiones bajos (_).

Máximo: 255

ecs_name

String

Nombre del servidor de backend.

Este parámetro es necesario si el tipo de instancia de backend es ecs. El valor puede contener de 1 a 64 caracteres, incluidos letras, dígitos, guiones (-), guiones bajos (_) y puntos (.).

Máximo: 64

id

String

ID de instancia de backend.

vpc_channel_id

String

ID de canal de VPC.

create_time

String

Hora en la que se agrega el servidor backend al canal de VPC.

member_group_id

String

ID de grupo de servidor de backend.

health_status

String

Estado de mantenimiento de la instancia de backend del canal de balanceo de carga. El valor puede ser desconocido, saludable o no saludable, lo que indica que no se realiza ninguna comprobación de estado, saludable o no saludable, respectivamente.

Código de estado: 400

Tabla 6 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: 401

Tabla 7 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: 403

Tabla 8 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: 404

Tabla 9 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 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.

Ejemplo de las solicitudes

Ninguno

Ejemplo de respuestas

Código de estado: 200

Aceptar

{
  "total" : 2,
  "size" : 2,
  "members" : [ {
    "host" : "192.168.0.5",
    "weight" : 1,
    "is_backup" : false,
    "member_group_name" : "",
    "status" : 1,
    "port" : 22,
    "ecs_id" : "192.168.0.5",
    "ecs_name" : "192.168.0.5",
    "id" : "be63c6260a1043888187f84af39c9f0e",
    "vpc_channel_id" : "56a7d7358e1b42459c9d730d65b14e59",
    "create_time" : "2020-07-23T07:11:57Z",
    "member_group_id" : "",
    "health_status" : "unhealthy"
  }, {
    "host" : "192.168.1.124",
    "weight" : 2,
    "is_backup" : false,
    "member_group_name" : "",
    "status" : 1,
    "port" : 22,
    "ecs_id" : "192.168.1.124",
    "ecs_name" : "192.168.1.124",
    "id" : "a57b13f1b89b417ca8acd76909e6df67",
    "vpc_channel_id" : "56a7d7358e1b42459c9d730d65b14e59",
    "create_time" : "2020-07-23T07:11:57Z",
    "member_group_id" : "",
    "health_status" : "unhealthy"
  } ]
}

Código de estado: 400

Error en la solicitud

{
  "error_code" : "APIG.2012",
  "error_msg" : "Invalid parameter value,parameterName:name. Please refer to the support documentation"
}

Código de estado: 401

Sin autorización

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

Código de estado: 403

Prohibido

{
  "error_code" : "APIG.1005",
  "error_msg" : "No permissions to request this method"
}

Código de estado: 404

No se ha encontrado

{
  "error_code" : "APIG.3023",
  "error_msg" : "The VPC channel does not exist,id:56a7d7358e1b42459c9d730d65b14e59"
}

Código de estado: 500

Error del servidor interno

{
  "error_code" : "APIG.9999",
  "error_msg" : "System error"
}

Códigos de estado

Código de estado

Descripción

200

Aceptar

400

Error en la solicitud

401

Sin autorización

403

Prohibido

404

No se ha encontrado

500

Error del servidor interno

Códigos de error

Consulte Códigos de error.

Tema principal: Gestión de canales de VPC