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/ Modificación de la comprobación del estado del canal de VPC
Actualización más reciente 2023-03-29 GMT+08:00
Ver PDF
Compartir

Modificación de la comprobación del estado del canal de VPC

Función

Esta API se utiliza para modificar la configuración de comprobación de estado de un canal de VPC.

URI

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

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

protocol

Sí

String

Protocolo para realizar comprobaciones de estado en servidores backend en el canal VPC.

  • TCP

  • HTTP

  • HTTPS

Valores de enumeración:

  • TCP

  • HTTP

  • HTTPS

path

No

String

Ruta de destino para las comprobaciones de estado. Este parámetro es necesario si el protocolo se establece en http o https.

method

No

String

Método de solicitud de comprobación de salud.

Predeterminado: GET

Valores de enumeración:

  • GET

  • HEAD

port

No

Integer

Puerto de destino para las comprobaciones de estado. Si este parámetro no se especifica o se establece en 0, se utiliza el puerto de host del canal VPC.

Si este parámetro se establece en un valor distinto de cero, se utiliza el puerto correspondiente para las comprobaciones de estado.

Mínimo: 0

Máximo: 65535

threshold_normal

Sí

Integer

Umbral saludable. Se refiere al número de comprobaciones exitosas consecutivas requeridas para que un servidor backend se considere saludable.

Mínimo: 2

Máximo: 10

threshold_abnormal

Sí

Integer

Umbral poco saludable. Se refiere al número de comprobaciones consecutivas fallidas requeridas para que un servidor de back-end se considere insalubre.

Mínimo: 2

Máximo: 10

time_interval

Sí

Integer

Intervalo entre comprobaciones consecutivas. Unidad: s. El valor debe ser mayor que el valor del tiempo de espera.

Mínimo: 5

Máximo: 300

http_code

No

String

Códigos de respuesta para determinar una respuesta HTTP correcta. El valor puede ser cualquier entero dentro de 100–599 en uno de los siguientes formatos:

  • Múltiples valores, por ejemplo, 200,201,202

  • Rango, por ejemplo, 200-299

  • Múltiples valores e intervalos, por ejemplo, 201,202,210-299. Este parámetro es necesario si el protocolo se establece en http.

enable_client_ssl

No

Boolean

Indica si se debe habilitar la autenticación bidireccional. Si esta función está habilitada, se utiliza el certificado especificado en el elemento de configuración backend_client_certificate de gateway.

Predeterminado: false

status

No

Integer

Resultado de comprobación de salud.

  • 1: disponible

  • 2: no disponible

Valores de enumeración:

  • 1

  • 2

timeout

Sí

Integer

Tiempo de espera para determinar si una comprobación de estado falla. Unidad: s. El valor debe ser menor que el valor de time_interval.

Mínimo: 2

Máximo: 30

Parámetros de respuesta

Código de estado: 200

Tabla 4 Parámetros de body de respuesta

Parámetro

Tipo

Descripción

protocol

String

Protocolo para realizar comprobaciones de estado en servidores backend en el canal VPC.

  • TCP

  • HTTP

  • HTTPS

Valores de enumeración:

  • TCP

  • HTTP

  • HTTPS

path

String

Ruta de destino para las comprobaciones de estado. Este parámetro es necesario si el protocolo se establece en http o https.

method

String

Método de solicitud de comprobación de salud.

Predeterminado: GET

Valores de enumeración:

  • GET

  • HEAD

port

Integer

Puerto de destino para las comprobaciones de estado. Si este parámetro no se especifica o se establece en 0, se utiliza el puerto de host del canal VPC.

Si este parámetro se establece en un valor distinto de cero, se utiliza el puerto correspondiente para las comprobaciones de estado.

Mínimo: 0

Máximo: 65535

threshold_normal

Integer

Umbral saludable. Se refiere al número de comprobaciones exitosas consecutivas requeridas para que un servidor backend se considere saludable.

Mínimo: 2

Máximo: 10

threshold_abnormal

Integer

Umbral poco saludable. Se refiere al número de comprobaciones consecutivas fallidas requeridas para que un servidor de back-end se considere insalubre.

Mínimo: 2

Máximo: 10

time_interval

Integer

Intervalo entre comprobaciones consecutivas. Unidad: s. El valor debe ser mayor que el valor del tiempo de espera.

Mínimo: 5

Máximo: 300

http_code

String

Códigos de respuesta para determinar una respuesta HTTP correcta. El valor puede ser cualquier entero dentro de 100–599 en uno de los siguientes formatos:

  • Múltiples valores, por ejemplo, 200,201,202

  • Rango, por ejemplo, 200-299

  • Múltiples valores e intervalos, por ejemplo, 201,202,210-299. Este parámetro es necesario si el protocolo se establece en http.

enable_client_ssl

Boolean

Indica si se debe habilitar la autenticación bidireccional. Si esta función está habilitada, se utiliza el certificado especificado en el elemento de configuración backend_client_certificate de gateway.

Predeterminado: false

status

Integer

Resultado de comprobación de salud.

  • 1: disponible

  • 2: no disponible

Valores de enumeración:

  • 1

  • 2

timeout

Integer

Tiempo de espera para determinar si una comprobación de estado falla. Unidad: s. El valor debe ser menor que el valor de time_interval.

Mínimo: 2

Máximo: 30

vpc_channel_id

String

ID de canal de VPC.

id

String

ID de comprabación de salud.

create_time

String

Hora de creación.

Código de estado: 400

Tabla 5 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 6 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 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: 404

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: 500

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.

Solicitudes de ejemplo

{
  "http_code" : "200",
  "path" : "/vpc/demo",
  "port" : 22,
  "protocol" : "http",
  "threshold_abnormal" : 5,
  "threshold_normal" : 2,
  "time_interval" : 10,
  "timeout" : 5,
  "enable_client_ssl" : false
}

Ejemplo de respuestas

Código de estado: 200

OK

{
  "protocol" : "http",
  "path" : "/vpc/demo",
  "method" : "GET",
  "port" : 22,
  "threshold_abnormal" : 5,
  "threshold_normal" : 2,
  "time_interval" : 10,
  "http_code" : "200",
  "enable_client_ssl" : false,
  "status" : 1,
  "timeout" : 5,
  "id" : "3b3d02026c5f402d85e8645ea95b0816",
  "vpc_channel_id" : "d38c55c926ca44c2bfb37886d93b9a0d",
  "create_time" : "2020-07-23T07:11:57Z"
}

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"
}

Status Codes

Status Code

Description

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