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> Elastic Load Balance> Referencia de la API> API del balanceador de carga dedicado> Comprobación de estado> Consulta de comprobaciones de estado

Actualización más reciente 2022-11-17 GMT+08:00

Ver PDF

Consulta de comprobaciones de estado

Función

Esta API se utiliza para consultar todas las comprobaciones de estado.

Restricciones

Esta API tiene las siguientes restricciones:

Los parámetros marker, limit y page_reverse se utilizan para la consulta de paginación.
Los parámetros marker y page_reverse solo tienen efecto cuando se usan junto con el parámetro limit.

URI

GET /v3/{project_id}/elb/healthmonitors

**Tabla 1** Parámetros de ruta
Parámetro	Obligatorio	Tipo	Descripción
project_id	Sí	String	Especifica el ID del proyecto.

**Tabla 2** Parámetros de consulta
Parámetro	Obligatorio	Tipo	Descripción
marker	No	String	Especifica el identificador del último registro de la página anterior. Nota: Este parámetro debe usarse junto con limit. Si no se especifica este parámetro, se consultará la primera página. Este parámetro no se puede dejar en blanco ni establecer un ID no válido.
limit	No	Integer	Especifica el número de registros de cada página. Mínimo: 0 Máximo: 2000 Predeterminado: 2000
page_reverse	No	Boolean	Especifica si se va a utilizar la consulta inversa. Valores: true: consulta la página anterior. false (predeterminado): consulta la página siguiente. Nota: Este parámetro debe usarse junto con limit. Si page_reverse se establece en true y desea consultar la página anterior, establezca el valor de marker en el valor de previous_marker.
id	No	Array	Especifica el ID de comprobación de estado. Se pueden consultar múltiples ID en el formato id=xxx&id=xxx.
monitor_port	No	Array	Especifica el puerto utilizado para la comprobación de estado. Se pueden consultar varios puertos en el formato monitor_port=xxx&monitor_port=xxx.
domain_name	No	Array	Especifica el nombre de dominio al que se envían las solicitudes HTTP durante la comprobación de estado. El valor puede contener solo dígitos, letras, guiones (-) y puntos (.) y debe comenzar con un dígito o letra. Se pueden consultar varios nombres de dominio en el formato domain_name=xxx&domain_name=xxx.
name	No	Array	Especifica el nombre de la comprobación de estado. Se pueden consultar varios nombres con el formato name=xxx&name=xxx.
delay	No	Array	Especifica el intervalo entre comprobaciones de estado, en segundos. El valor varía de 1 a 50. Se pueden consultar varios intervalos en el formato de delay=xxx&delay=xxx.
max_retries	No	Array	Especifica el número de comprobaciones de estado consecutivas cuando el resultado de la comprobación de estado de un servidor backend cambia de OFFLINE a ONLINE. Se pueden consultar varios valores en el formato max_retries=xxx&max_retries=xxx.
admin_state_up	No	Boolean	Especifica el estado administrativo de la comprobación de estado. El valor puede ser true (la comprobación de estado está habilitada) o false (la comprobación de estado está deshabilitada).
max_retries_down	No	Array	Especifica el número de comprobaciones de estado consecutivas cuando el resultado de la comprobación de estado de un servidor backend cambia de ONLINE a OFFLINE. El valor varía de 1 a 10. Se pueden consultar varios valores en el formato max_retries_down=xxx&max_retries_down=xxx.
timeout	No	Integer	Especifica el tiempo máximo necesario para esperar una respuesta de la comprobación de estado, en segundos.
type	No	Array	Especifica el protocolo de comprobación de estado. El valor puede ser TCP, UDP_CONNECT, HTTP, o HTTPS.. Se pueden consultar varios protocolos en el formato type=xxx&type=xxx.
expected_codes	No	Array	Especifica el código de estado HTTP esperado. Este parámetro solo tendrá efecto cuando type se establece en HTTP o HTTPS. A continuación se describen las opciones de valores: Un valor específico, por ejemplo, 200 Una lista de valores separados por comas (,), por ejemplo, 200, 202 Un rango de valores, por ejemplo, 200-204 El valor predeterminado es 200. Se pueden consultar varios códigos de estado en el formato de expected_codes=xxx&expected_codes=xxx.
url_path	No	Array	Especifica la ruta de solicitud HTTP para la comprobación de estado. El valor debe comenzar con una barra diagonal (/), y el valor predeterminado es /. Este parámetro solo está disponible cuando type está establecido en HTTP. Se pueden consultar varias rutas en el formato url_path=xxx&url_path=xxx.
http_method	No	Array	Especifica el método HTTP. El valor puede ser GET, HEAD, POST, PUT, DELETE, TRACE, OPTIONS, CONNECT, o PATCH. Se pueden consultar varios métodos en el formato http_method=xxx&http_method=xxx. Este parámetro no es compatible. Por favor, no lo use.
enterprise_project_id	No	Array	Especifica el ID del proyecto de empresa. Si no se pasa este parámetro, se consultan los recursos del proyecto de empresa predeterminado y se realiza la autenticación en función del proyecto de empresa predeterminado. Si se pasa este parámetro, su valor puede ser el ID de un proyecto de empresa existente (se requieren recursos en el proyecto de empresa específico) o all_granted_eps (se consultan recursos en todos los proyectos de empresa). Se pueden consultar varios identificadores en el formato enterprise_project_id=xxx&enterprise_project_id=xxx. Este parámetro no es compatible. Por favor, no lo use.

Parámetros de solicitud

**Tabla 3** Parámetros de cabecera de solicitud
Parámetro	Obligatorio	Tipo	Descripción
X-Auth-Token	Sí	String	Especifica el token utilizado para la autenticación IAM.

Parámetros de respuesta

Código de estado: 200

**Tabla 4** Parámetros del cuerpo de respuesta
Parámetro	Tipo	Descripción
request_id	String	Especifica el ID de la solicitud. El valor se genera automáticamente.
page_info	PageInfo object	Muestra información de paginación.
healthmonitors	Array of HealthMonitor objects	Especifica la comprobación de estado.

**Tabla 5** PageInfo
Parámetro	Tipo	Descripción
previous_marker	String	Especifica el ID del primer registro del resultado de la consulta de paginación. Establezca este parámetro para consultar la página anterior.
next_marker	String	Especifica el ID del último registro del resultado de la consulta de paginación. Establezca este parámetro para consultar la página siguiente.
current_count	Integer	Especifica el número de registros.

**Tabla 6** HealthMonitor
Parámetro	Tipo	Descripción
admin_state_up	Boolean	Especifica el estado administrativo de la comprobación de estado. true (predeterminado) indica que la comprobación de estado está activada. false indica que la comprobación de estado está deshabilitada.
delay	Integer	Especifica el intervalo entre comprobaciones de estado, en segundos. El valor varía de 1 a 50. Mínimo: 1 Máximo: 50
domain_name	String	Especifica el nombre de dominio al que se envían las solicitudes HTTP durante la comprobación de estado. El valor puede contener solo dígitos, letras, guiones (-) y puntos (.) y debe comenzar con un dígito o letra. El valor se deja en blanco de forma predeterminada, lo que indica que la dirección IP virtual del balanceador de carga se utiliza como la dirección de destino de las solicitudes HTTP. Este parámetro solo está disponible cuando type está establecido en HTTP.
expected_codes	String	Especifica el código de estado HTTP esperado. Este parámetro solo tendrá efecto cuando type se establece en HTTP o HTTPS. A continuación se describen las opciones de valores: Un valor específico, por ejemplo, 200 Una lista de valores separados por comas (,), por ejemplo, 200, 202 Un rango de valores, por ejemplo, 200-204 El valor predeterminado es 200. Se pueden consultar varios códigos de estado en el formato de expected_codes=xxx&expected_codes=xxx.
http_method	String	Especifica el método HTTP. El valor puede ser GET, HEAD, POST, PUT, DELETE, TRACE, OPTIONS, CONNECT, o PATCH. El valor predeterminado es GET. Este parámetro está disponible cuando type se establece en HTTP o HTTPS. Este parámetro no es compatible. Por favor, no lo use.
id	String	Especifica el ID de comprobación de estado.
max_retries	Integer	Especifica el número de comprobaciones de estado consecutivas cuando el resultado de la comprobación de estado de un servidor backend cambia de OFFLINE a ONLINE. El valor varía de 1 a 10 Mínimo: 1 Máximo: 10
max_retries_down	Integer	Especifica el número de comprobaciones de estado consecutivas cuando el resultado de la comprobación de estado de un servidor backend cambia de ONLINE a OFFLINE. El valor varía de 1 a 10, y el valor predeterminado es 3. Mínimo: 1 Máximo: 10
monitor_port	Integer	Especifica el puerto utilizado para la comprobación de estado. Si este parámetro se deja en blanco, se utilizará un puerto del servidor backend de forma predeterminada. El número de puerto se encuentra dentro del rango de 1 a 65535. Mínimo: 1 Máximo: 65535
name	String	Especifica el nombre de la comprobación de estado.
pools	Array of PoolRef objects	Muestra los ID de los grupos de servidores backend para los que está configurada la comprobación de estado. Solo se devolverá un ID.
project_id	String	Especifica el ID del proyecto.
timeout	Integer	Especifica el tiempo máximo necesario para esperar una respuesta de la comprobación de estado, en segundos. Se recomienda que establezca el valor menor que el parámetro delay. Mínimo: 1 Máximo: 50
type	String	Especifica el protocolo de comprobación de estado. El valor puede ser TCP, UDP_CONNECT, HTTP, o HTTPS.. Nota: Si el protocolo del servidor backend es QUIC, el valor solo puede ser UDP_CONNECT. Si el protocolo del servidor backend es UDP, el valor solo puede ser UDP_CONNECT. Si el protocolo del servidor backend es TCP, el valor solo puede ser TCP, HTTP o HTTPS. Si el protocolo del servidor backend es HTTP, el valor solo puede ser TCP, HTTP o HTTPS. Si el protocolo del servidor backend es HTTPS, el valor solo puede ser TCP, HTTP o HTTPS. El protocolo QUIC no se admite en la región eu-nl.
url_path	String	Especifica la ruta de solicitud HTTP para la comprobación de estado. El valor debe comenzar con una barra diagonal (/), y el valor predeterminado es /. Nota: Este parámetro solo está disponible cuando type está establecido en HTTP.
created_at	String	Especifica la hora a la que se configuró la comprobación de estado. El formato es yyyy-MM-dd'T'HH:mm:ss'Z' (hora UTC). Este es un campo nuevo en esta versión, y no se devolverá para los recursos asociados con balanceadores de carga dedicados existentes y para los recursos asociados con balanceadores de carga compartidos existentes y nuevos.
updated_at	String	Especifica la hora a la que se actualizó la comprobación de estado. El formato es yyyy-MM-dd'T'HH:mm:ss'Z' (hora UTC). Este es un campo nuevo en esta versión, y no se devolverá para los recursos asociados con balanceadores de carga dedicados existentes y para los recursos asociados con balanceadores de carga compartidos existentes y nuevos.

**Tabla 7** PoolRef
Parámetro	Tipo	Descripción
id	String	Especifica el ID del grupo de servidores backend.

Ejemplo de las solicitudes

GET https://{ELB_Endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/healthmonitors

Ejemplo de las respuestas

Código de estado: 200

Solicitud exitosa.

{
  "healthmonitors" : [ {
    "monitor_port" : null,
    "id" : "c2b210b2-60c4-449d-91e2-9e9ea1dd7441",
    "project_id" : "99a3fff0d03c428eac3678da6a7d0f24",
    "domain_name" : null,
    "name" : "My Healthmonitor update",
    "delay" : 10,
    "max_retries" : 10,
    "pools" : [ {
      "id" : "488acc50-6bcf-423d-8f0a-0f4184f5b8a0"
    } ],
    "admin_state_up" : true,
    "timeout" : 30,
    "type" : "HTTP",
    "expected_codes" : "200",
    "url_path" : "/",
    "http_method" : "GET"
  }, {
    "monitor_port" : null,
    "id" : "cda1af03-0660-4fd2-8edf-e38c79846e08",
    "project_id" : "99a3fff0d03c428eac3678da6a7d0f24",
    "domain_name" : "akik..un.com",
    "name" : "lijunqiu",
    "delay" : 50,
    "max_retries" : 1,
    "pools" : [ {
      "id" : "ae6e45ba-be84-4074-8ac6-bc4a56484809"
    } ],
    "admin_state_up" : false,
    "timeout" : 3,
    "type" : "UDP_CONNECT",
    "expected_codes" : null,
    "url_path" : "/world",
    "http_method" : null
  } ],
  "page_info" : {
    "next_marker" : "cda1af03-0660-4fd2-8edf-e38c79846e08",
    "previous_marker" : "c2b210b2-60c4-449d-91e2-9e9ea1dd7441",
    "current_count" : 2
  },
  "request_id" : "814bc40e-8b0a-4ced-b8e5-f136c3e1df6a"
}