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/ Las API de gateway dedicado (V2)/ Gestión de canales de VPC/ Consulta de grupos de servidores backend de un canal de VPC
Actualización más reciente 2023-03-29 GMT+08:00

Consulta de grupos de servidores backend de un canal de VPC

Función

Esta API se utiliza para consultar grupos de servidores backend de un canal de VPC.

URI

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

Tabla 1 Parámetros de path

Parámetro

Obligatorio

Tipo

Descripción

project_id

String

ID del proyecto. Para obtener detalles sobre cómo obtener un ID de proyecto, consulte "Apéndice" > "Obtención de un ID de proyecto" en este documento.

instance_id

String

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

vpc_channel_id

String

ID de canal de VPC.

Tabla 2 Parámetros de Query

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

dict_code

No

String

Código del diccionario.

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

member_group_name

No

String

Nombre del grupo del servidor backend del canal VPC.

precise_search

No

String

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

Actualmente, se admite member_group_name.

Parámetros de solicitud

Tabla 3 Parámetros de encabezado de solicitud

Parámetro

Obligatorio

Tipo

Descripción

X-Auth-Token

String

Token de usuario. Se puede obtener llamando 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 de body 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.

member_groups

Array of MemberGroupInfo objects

Grupos de servidores backend del canal VPC.

Tabla 5 MemberGroupInfo

Parámetro

Tipo

Descripción

member_group_name

String

Nombre del grupo de servidores backend del canal VPC.

member_group_remark

String

Descripción del grupo de servidores backend.

member_group_weight

Integer

Peso del grupo de servidores backend.

Si el grupo de servidores contiene servidores y se ha establecido un peso para él, el peso se utiliza automáticamente para asignar pesos 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.

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 6 MicroserviceLabel

Parámetro

Tipo

Descripción

label_name

String

Nombre de la etiqueta.

Comience y termine con una letra o dígito. Utilice 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.

Comience y termine con una letra o dígito. Utilice solo letras, dígitos, guiones (-), guiones bajos (_), y puntos (.). (Máx. 63 caracteres.)

Mínimo: 1

Máximo 63

Código de estado: 400

Tabla 7 Parámetros de body 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 8 Parámetros de body 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 9 Parámetros de body 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 10 Parámetros de body 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 body de respuesta

Parámetro

Tipo

Descripción

error_code

String

Código de error.

error_msg

String

Mensaje de error.

Solicitudes de ejemplo

Ninguna

Ejemplo de respuestas

Código de estado: 200

OK

{
  "total" : 1,
  "size" : 1,
  "member_groups" : [ {
    "member_group_name" : "vpc_member_group",
    "member_group_remark" : "remark",
    "member_group_weight" : 1,
    "dict_code" : "",
    "member_group_id" : "105c6902457144a4820dff8b1ad63331",
    "create_time" : "2020-07-23T07:24:33Z",
    "update_time" : "2020-07-23T07:24:33Z",
    "microservice_version" : "",
    "microservice_port" : 0,
    "microservice_labels" : [ ]
  } ]
}

Código de estado: 400

Bad Request

{
  "error_code" : "APIG.2001",
  "error_msg" : "The request parameters must be specified, parameter name:members"
}

Código de estado: 401

Unauthorized

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

Código de estado: 403

Forbidden

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

Código de estado: 404

Not Found

{
  "error_code" : "APIG.3030",
  "error_msg" : "The instance does not exist,id:56a7d7358e1b42459c9d730d65b14e59"
}

Código de estado: 500

Internal Server Error

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

Códigos de estado

Código de estado

Descripción

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Error del servidor interno

Códigos de error

Consulte Códigos de error.