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/ Actualización de instancias de backend
Actualización más reciente 2023-03-29 GMT+08:00
Ver PDF
Compartir

Actualización de instancias de backend

Función

Esta API se utiliza para actualizar las instancias de backend de un canal de VPC especificado. Durante la actualización, los parámetros de solicitud sobrescriben las instancias de backend del grupo de servidores en la nube correspondiente. Si no se especifica ningún grupo de servidores en la nube, se sobrescriben todos los grupos de servidores en la nube.

URI

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

Tabla 1 Parámetros de path

Parámetro

Obligatorio

Tipo

Descripción

project_id

Sí

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

Sí

String

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

vpc_channel_id

Sí

String

ID de canal de VPC.

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. 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.
Tabla 3 Parámetros de body de solicitud

Parámetro

Obligatorio

Tipo

Descripción

members

No

Array of MemberInfo objects

Instancias de backend.

member_group_name

No

String

Grupo de servidores de backend que se modificará.

Si no se especifica este parámetro, se modifican todos los backend definidos por los miembros para el canal VPC.

Si se especifica este parámetro, solo se modifican las instancias de backend del grupo de servidores de backend definidos por los miembros. Los parámetros de entrada de otros grupos de servidores backend se ignoran. Por ejemplo, si se pasa member_group_name=primary, solo se modifican las instancias de backend del grupo de servidores backend 105c6902457144a4820dff8b1ad63331 en los miembros.
Tabla 4 MemberInfo

Parámetro

Obligatorio

Tipo

Descripción

host

No

String

Dirección del servidor backend.

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

Máximo: 64

weight

No

Integer

Peso.

Cuanto mayor sea el peso, más solicitudes recibirá un servicio de back-end.

Mínimo: 0

Máximo: 10000

is_backup

No

Boolean

Indica si el servicio backend es un nodo en espera.

Después de habilitar esta función, el servicio de backend sirve como nodo en espera. Funciona solo cuando todos los nodos no en espera están defectuosos.

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

No

String

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

status

No

Integer

Estado del servidor backend.

  • 1: disponible

  • 2: no disponible

Valores de enumeración:

  • 1

  • 2

port

No

Integer

Puerto de servidor de backend.

Mínimo: 0

Máximo: 65535

ecs_id

No

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, incluyendo letras, dígitos, guiones (-) y guiones bajos (_).

Máximo: 255

ecs_name

No

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, incluyendo letras, dígitos, guiones (-), guiones bajos (_), y puntos (.).

Máximo: 64

Parámetros de respuesta

Código de estado: 200

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

members

Array of VpcMemberInfo objects

Lista de servidores en la nube.
Tabla 6 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: 64

weight

Integer

Peso.

Cuanto mayor sea el peso, más solicitudes recibirá un servicio de back-end.

Mínimo: 0

Máximo: 10000

is_backup

Boolean

Indica si el servicio backend es un nodo en espera.

Después de habilitar esta función, el servicio de backend sirve como nodo en espera. Funciona solo cuando todos los nodos no en espera están defectuosos.

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 del servidor de 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

Valores de enumeración:

  • 1

  • 2

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, incluyendo 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, incluyendo letras, dígitos, guiones (-), guiones bajos (_), y puntos (.).

Máximo: 64

id

String

ID del servidor 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.

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

  • Actualización de instancias de backend no en espera de un canal de VPC

    {
  "member_group_name" : "primary",
  "members" : [ {
    "host" : "192.168.2.25",
    "weight" : 1,
    "is_backup" : false,
    "member_group_name" : "primary"
  } ]
}

  • Actualización de todas las instancias de backend de un canal de VPC

    {
  "members" : [ {
    "ecs_id" : "1082720c-3c15-409c-9ae3-4983ddfb6a9d",
    "ecs_name" : "APIGtest02",
    "weight" : 2
  } ]
}

Ejemplo de respuestas

Código de estado: 200

OK

  • Ejemplo 1

    {
  "total" : 1,
  "size" : 1,
  "members" : [ {
    "host" : "192.168.2.25",
    "weight" : 1,
    "is_backup" : false,
    "member_group_name" : "primary",
    "port" : 22,
    "status" : 1,
    "ecs_id" : "192.168.2.25",
    "ecs_name" : "192.168.2.25",
    "id" : "683b6807cad54122a6777ad047a6178e",
    "vpc_channel_id" : "56a7d7358e1b42459c9d730d65b14e59",
    "create_time" : "2020-07-23T09:13:24Z",
    "member_group_id" : "631b551cddda40478ef720163a9412ed"
  } ]
}

  • Ejemplo 2

    {
  "total" : 1,
  "size" : 1,
  "members" : [ {
    "host" : "192.168.0.17",
    "weight" : 2,
    "is_backup" : false,
    "member_group_name" : "primary",
    "port" : 22,
    "status" : 1,
    "ecs_id" : "1082720c-3c15-409c-9ae3-4983ddfb6a9d",
    "ecs_name" : "APIGtest02",
    "id" : "5c868f0224084710a1e188b7d3057c52",
    "vpc_channel_id" : "105c6902457144a4820dff8b1ad63331",
    "create_time" : "2020-07-23T09:03:53Z",
    "member_group_id" : "631b551cddda40478ef720163a9412ed"
  } ]
}

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.3023",
  "error_msg" : "The VPC channel 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

Internal Server Error

Códigos de error

Consulte Códigos de error.

Tema principal: Gestión de canales de VPC