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 canales de VPC

Actualización más reciente 2025-12-22 GMT+08:00

Ver PDF

Consulta de canales de VPC

Función

Esta API se utiliza para consultar los canales de VPC en un gateway.

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

**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.

**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
id	No	String	ID de canal de VPC.
name	No	String	Nombre del canal de VPC.
dict_code	No	String	Código de diccionario del canal VPC. El valor puede contener letras, dígitos, guiones (-), guiones bajos (_), y puntos (.). Este parámetro no se admite actualmente. Mínimo: 3 Máximo: 64
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.
member_host	No	String	Dirección de servicio de backend. De forma predeterminada, se utiliza la coincidencia exacta. No se admite la coincidencia difusa.
member_port	No	Integer	Puerto de servidor de backend. Mínimo: 0 Máximo: 65535
member_group_name	No	String	Nombre del grupo de servidores backend.
member_group_id	No	String	ID de grupo de servidor de backend.
vpc_channel_type	No	String	Tipo de canal de VPC. builtin: tipo de servidor microservice: tipo de microservicio reference: canal de balanceo de carga de referencia

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.
vpc_channels	Array of VpcChannelInfo objects	Lista de canales de VPC.

**Tabla 5** VpcChannelInfo
Parámetro	Tipo	Descripción
name	String	Nombre del canal de VPC. Puede contener de 3 a 64 caracteres, comenzando con una letra. Solo se permiten letras, dígitos, guiones (-), guiones bajos (_) y puntos (.).
port	Integer	Puerto de host del canal VPC. Rango: 1–65535.
balance_strategy	Integer	Algoritmo de distribución. 1: Round robin ponderado (WRR). 2: Conexiones mínimas ponderadas (WLC). 3: Hashing de origen. 4: Hashing de URI. Predeterminado: 1
member_type	String	Tipo de miembro del canal VPC. ip ecs Predeterminado: ecs
type	Integer	Tipo de canal de VPC. El tipo predeterminado es servidor. 2: Tipo de servidor 3: Tipo de microservicio Si vpc_channel_type está vacío, el tipo de canal de balanceo de carga está determinado por el campo de type. Si el valor de type no es 3 o el valor de microservice_info está vacío, el tipo de canal de balanceo de carga es server por defecto. Si el valor de type es 3 y el valor de microservice_info no está vacío, el tipo de canal de balanceo de carga es microservice. Cuando se modifica un canal de balanceo de carga, el tipo de canal permanecerá sin cambios. Este campo debe descartarse. Utilice el campo vpc_channel_type para especificar el tipo de canal de balanceo de carga. Predeterminado: 2
vpc_channel_type	String	Tipo de canal de VPC. builtin: tipo de servidor microservice: tipo de microservicio reference: canal de balanceo de carga de referencia Si vpc_channel_type está vacío, el tipo de canal de balanceo de carga depende del valor del campo de type. Si vpc_channel_type no está vacío y type no está vacío o no es cero, se produce un error cuando se especifican. Si vpc_channel_type no está vacío y type está vacío o 0, el valor de vpc_channel_type se utiliza para especificar el tipo de canal de equilibrio de carga. Cuando se modifica un canal de balanceo de carga, el tipo de canal permanecerá sin cambios.
dict_code	String	Código de diccionario del canal VPC. El valor puede contener letras, dígitos, guiones (-), guiones bajos (_), y puntos (.). Este parámetro no se admite actualmente. Mínimo: 3 Máximo: 64
create_time	String	Hora en la que se crea el canal VPC.
id	String	ID de canal de VPC.
status	Integer	Estado del canal de VPC. 1: normal 2: anormal
member_groups	Array of MemberGroupInfo objects	Grupos de servidores backend.
microservice_info	MicroServiceInfo object	Información de microservicio.

**Tabla 6** MemberGroupInfo
Parámetro	Tipo	Descripción
member_group_name	String	Nombre del grupo de servidores backend del canal de VPC. Puede contener de 3 a 64 caracteres, comenzando con una letra. Solo se permiten letras, dígitos, guiones bajos (_), guiones medios (-) y puntos (.).
member_group_remark	String	Descripción del grupo de servidores backend. Máximo: 255
member_group_weight	Integer	Ponderación del grupo de servidores backend. Si el grupo de servidores contiene servidores y se ha establecido una ponderación para él, la ponderación se utiliza automáticamente para asignar ponderaciones a los servidores de este grupo. Mínimo: 0 Máximo: 100
dict_code	String	Código de diccionario del grupo de servidores backend. El valor puede contener letras, dígitos, guiones (-), guiones bajos (_), y puntos (.). Actualmente, este parámetro no es compatible. Mínimo: 3 Máximo: 64
microservice_version	String	Versión del grupo de servidores backend. Este parámetro solo se admite cuando el tipo de canal de VPC es microservicio. Máximo: 64
microservice_port	Integer	Puerto del grupo de servidores de backend. Este parámetro solo se admite cuando el tipo de canal de VPC es microservicio. Si el número de puerto es 0, todas las direcciones en el grupo de servidores backend utilizan el puerto de equilibrio de carga original para heredar la lógica. Mínimo: 0 Máximo: 65535
microservice_labels	Array of MicroserviceLabel objects	Etiquetas del grupo de servidores de backend. Este parámetro solo se admite cuando el tipo de canal de VPC es microservicio.
reference_vpc_channel_id	String	ID del canal de balanceo de carga de referencia. Este parámetro solo se admite cuando el tipo de canal de VPC es de referencia (vpc_channel_type=reference). Mínimo: 0 Máximo: 64
member_group_id	String	ID del grupo de servidores backend del canal VPC.
create_time	String	Hora en la que se crea el grupo de servidores de backend.
update_time	String	Hora en la que se actualiza el grupo de servidores de backend.

**Tabla 7** MicroserviceLabel
Parámetro	Tipo	Descripción
label_name	String	Nombre de la etiqueta. Se comienza y se termina con una letra o un dígito. Se utiliza solo letras, dígitos, guiones (-), guiones bajos (_) y puntos (.). (Máx. 63 caracteres.) Mínimo: 1 Máximo: 63
label_value	String	Valor de la etiqueta. Se comienza y se termina con una letra o un dígito. Se utiliza solo letras, dígitos, guiones (-), guiones bajos (_) y puntos (.). (Máx. 63 caracteres.) Mínimo: 1 Máximo: 63

**Tabla 8** MicroServiceInfo
Parámetro	Tipo	Descripción
id	String	ID de microservicio.
instance_id	String	ID de gateway.
service_type	String	Tipo de centro de microservicios. Opciones: CSE: Centro de registro de microservicios CSE. CCE: Carga de trabajo de CCE - CCE_SERVICE: Servicio de CCE NACOS: motor de Nacos. nacos_info es obligatorio.
cse_info	MicroServiceInfoCSE object	Detalles del microservicio de CSE.
cce_info	MicroServiceInfoCCE object	Detalles de carga de trabajo de microservicios de CCE.
cce_service_info	MicroServiceInfoCCEService object	Detalles del servicio de microservicios de CCE.
nacos_info	MicroServiceInfoNacosBase object	Información básica de Nacos.
update_time	String	Tiempo de actualización del microservicio.
create_time	String	Tiempo de creación de microservicios.

**Tabla 9** MicroServiceInfoCSE
Parámetro	Tipo	Descripción
engine_id	String	ID del motor de microservicio. Máximo: 64
service_id	String	ID de microservicio. Máximo: 64
engine_name	String	Nombre del motor de microservicios.
service_name	String	Nombre del microservicio.
register_address	String	Dirección del centro de registro.
cse_app_id	String	Aplicación a la que pertenece el microservicio.
version	String	Versión de microservicio, que se ha descartado y se refleja en la versión del grupo de servidores de backend. Máximo: 64

**Tabla 10** MicroServiceInfoCCE
Parámetro	Tipo	Descripción
cluster_id	String	ID del clúster de CCE. Máximo: 64
namespace	String	Espacio de nombres. Máximo: 64
workload_type	String	Tipo de carga de trabajo. deployment statefulset daemonset
app_name	String	Nombre de la aplicación. Se comienza con una letra e incluya solo letras, dígitos, puntos (.), guiones (-) y guiones bajos (_). (de 1 a 64 caracteres) Mínimo: 1 Máximo: 64
label_key	String	Clave de etiqueta de servicio. Se comienza con una letra o un dígito, y se usa solo letras, dígitos y estos caracteres especiales: -_./:(). (de 1 a 64 caracteres) Mínimo: 1 Máximo: 64
label_value	String	Valor de etiqueta de servicio. Se comienza con una letra e incluya solo letras, dígitos, puntos (.), guiones (-) y guiones bajos (_). (de 1 a 64 caracteres) Mínimo: 1 Máximo: 64
cluster_name	String	Nombre del clúster de CCE.

**Tabla 11** MicroServiceInfoCCEService
Parámetro	Tipo	Descripción
cluster_id	String	ID del clúster de CCE. Máximo: 64
namespace	String	Espacio de nombres. De 1 a 63 caracteres. Se utiliza letras minúsculas, dígitos y guiones (-). Se comienza con una letra y se termina con una letra o un dígito. Mínimo: 1 Máximo: 63
service_name	String	Nombre del servicio. Se comienza con una letra y se utiliza solo letras, dígitos, puntos (.), guiones (-) y guiones bajos (_). (de 1 a 64 caracteres) Mínimo: 1 Máximo: 64
cluster_name	String	Nombre del clúster de CCE.

**Tabla 12** MicroServiceInfoNacosBase
Parámetro	Tipo	Descripción
namespace	String	ID de espacio de nombres. Si se utiliza el espacio de nombres predeterminado public, deje este parámetro vacío. Solo se permiten letras, números, guiones (-) y guiones bajos (_). Máximo: 64 caracteres Mínimo: 0 Máximo: 64
cluster_name	String	Nombre del clúster. El valor predeterminado es DEFAULT. Solo se permiten letras, números, guiones (-) y guiones bajos (_).Max.: 64 characters Mínimo: 0 Máximo: 64
group_name	String	Nombre del grupo. El valor predeterminado es DEFAULT_GROUP. Solo se permiten letras, números, guiones (-), guiones bajos (_), puntos (.) y dos puntos. Máximo: 128 caracteres Mínimo: 0 Máximo: 128
service_name	String	Nombre del microservicio. El valor no puede comenzar con @ o contener @@. Máximo: 512 caracteres Mínimo: 1 Máximo: 512
server_config	Array of NacosServerConfig objects	Configuraciones del servidor Nacos. Longitud de matriz: 1 - 9
user_info	NacosUserInfo object	Información del usuario de Nacos.

**Tabla 13** NacosServerConfig
Parámetro	Tipo	Descripción
ip_address	String	Dirección IP del servidor de Nacos. No ingrese caracteres chinos. Mínimo: 7 Máximo: 128
port	Integer	Número de puerto del servidor de Nacos. Rango: 1–65535. Mínimo: 1 Máximo: 65535
grpc_port	Integer	Número de puerto gRPC del servidor de Nacos. Predeterminado: número de puerto + 1000 Rango: 1–65535. Mínimo: 1 Máximo: 65535

**Tabla 14** NacosUserInfo
Parámetro	Tipo	Descripción
user_name	String	Nombre de usuario de Nacos. Mínimo: 1 Máximo: 64
password	String	Contraseña de Nacos. Mínimo: 1 Máximo: 64

Código de estado: 400

**Tabla 15** 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 16** 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 17** 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 18** 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 19** 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,
  "vpc_channels" : [ {
    "name" : "channel 1",
    "port" : 8080,
    "balance_strategy" : 1,
    "member_type" : "ip",
    "dict_code" : "",
    "create_time" : "2020-07-23T07:24:33Z",
    "id" : "105c6902457144a4820dff8b1ad63331",
    "status" : 1,
    "member_groups" : [ ],
    "type" : 2,
    "microservice_info" : {
      "id" : "",
      "instance_id" : "",
      "service_type" : "",
      "cse_info" : {
        "cse_app_id" : "",
        "engine_id" : "",
        "engine_name" : "",
        "register_address" : "",
        "service_id" : "",
        "service_name" : ""
      },
      "cce_info" : {
        "cluster_id" : "",
        "cluster_name" : "",
        "namespace" : "",
        "workload_type" : "",
        "app_name" : ""
      },
      "create_time" : "",
      "update_time" : ""
    }
  }, {
    "name" : "channel 2",
    "port" : 8088,
    "balance_strategy" : 2,
    "member_type" : "ip",
    "dict_code" : "",
    "create_time" : "2020-07-23T07:11:57Z",
    "id" : "56a7d7358e1b42459c9d730d65b14e59",
    "status" : 1,
    "member_groups" : [ ],
    "type" : 3,
    "microservice_info" : {
      "id" : "9483afa235be45158a70c19ab817ac65",
      "instance_id" : "eddc4d25480b4cd6b512f270a1b8b341",
      "service_type" : "CCE",
      "cse_info" : {
        "cse_app_id" : "",
        "engine_id" : "",
        "engine_name" : "",
        "register_address" : "",
        "service_id" : "",
        "service_name" : ""
      },
      "cce_info" : {
        "cluster_id" : "ab1485b4f91b45abbcd560be591f7309",
        "cluster_name" : "cce-test",
        "namespace" : "default",
        "workload_type" : "deployment",
        "app_name" : "testapp"
      },
      "create_time" : "2020-07-23T07:11:57.244829604Z",
      "update_time" : "2020-07-23T07:11:57.244829604Z"
    }
  } ]
}

Código de estado: 400

Error en la solicitud

{
  "error_code" : "APIG.2011",
  "error_msg" : "The request parameters must be specified,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.3030",
  "error_msg" : "The instance does not exist;id:eddc4d25480b4cd6b512f270a1b8b341"
}

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

Tema anterior: Consulta de detalles del canal de VPC

Tema siguiente: Adición o actualización de instancias de backend

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