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 de Balanceador de carga compartido/ 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. Se admite la consulta de filtro y la consulta de paginación. A menos que se especifique lo contrario, se aplica una coincidencia exacta.

URI

GET /v2/{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 ID de la comprobación de estado desde la que se inicia la consulta de paginación, es decir, el ID de la última comprobación de estado de la página anterior. Este parámetro debe usarse con limit.
limit	No	Integer	Especifica el número de comprobaciones de estado de cada página. Si este parámetro no está definido, todas las comprobaciones de estado se consultan de forma predeterminada.
page_reverse	No	Boolean	Especifica la dirección de la página. El valor puede ser true o false, y el valor predeterminado es false. La última página de la lista solicitada con page_reverse establecido en false no contendrá el enlace "next", y la última página de la lista solicitada con page_reverse establecido en true no contendrá el enlace "anterior". Este parámetro debe usarse con limit.
id	No	String	Especifica el ID de comprobación de estado.
tenant_id	No	String	Especifica el ID del proyecto en el que se realiza la comprobación de estado. El valor contiene un máximo de 255 caracteres.
project_id	No	String	Especifica el ID del proyecto al que pertenece la comprobación de estado. Este parámetro tiene el mismo significado que tenant_id.
name	No	String	Especifica el nombre de la comprobación de estado. El valor contiene un máximo de 255 caracteres.
delay	No	Integer	Especifica el tiempo máximo entre comprobaciones de estado en la unidad de segundo. El valor varía de 1 a 50.
max_retries	No	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.
admin_state_up	No	Boolean	Especifica el estado administrativo de la comprobación de estado. El valor puede ser true o false. El valor predeterminado es true. true: indica que la función de comprobación de estado está habilitada. false: indica que la función de comprobación de estado está deshabilitada.
timeout	No	Integer	Especifica la duración del tiempo de espera de comprobación de estado en la unidad de segundo. El valor varía de 1 a 50. NOTA: Se recomienda establecer el valor menor que el de parámetro delay.
type	No	String	Especifica el protocolo de comprobación de estado. El valor puede ser TCP, UDP_CONNECT o HTTP.
monitor_port	No	Integer	Especifica el puerto utilizado para la comprobación de estado. El valor se deja en blanco de forma predeterminada, lo que indica que el puerto del servidor backend se utiliza como puerto de comprobación de estado.
expected_codes	No	String	Especifica el código de estado HTTP esperado. Las siguientes opciones están disponibles: A single value, such as 200 A list of values, such as 200,202 Un rango de valores, como 200–204 Este parámetro solo tiene efecto cuando el valor de type se establece en HTTP. El valor incluye un máximo de 64 caracteres. NOTA: Este parámetro está reservado.
domain_name	No	String	Especifica el nombre de dominio de las solicitudes HTTP durante la comprobación de estado. Este parámetro solo tiene efecto cuando el valor de type se establece en HTTP. El valor se deja en blanco de forma predeterminada, lo que indica que la dirección IP privada del balanceador de carga se utiliza como la dirección de destino de las solicitudes HTTP. El valor puede contener solo dígitos, letras, guiones (-) y puntos (.) y debe comenzar con un dígito o letra, por ejemplo: www.test.com. El valor contiene un máximo de 100 caracteres.
url_path	No	String	Especifica la ruta de solicitud HTTP para la comprobación de estado. El valor predeterminado es /. El valor comienza con una barra (/). Este parámetro solo tiene efecto cuando el valor de type se establece en HTTP. Un valor de ejemplo es /test. El valor contiene un máximo de 255 caracteres.
http_method	No	String	Especifica el método de solicitud HTTP. El valor predeterminado es GET. El valor puede ser GET, HEAD, POST, PUT, DELETE, TRACE, OPTIONS, CONNECT, o PATCH. Este parámetro solo tiene efecto cuando el valor de type se establece en HTTP. NOTA: Este parámetro está reservado.

Solicitud

No hay

Respuesta

**Tabla 3** Descripción del parámetro
Parámetro	Tipo	Descripción
healthmonitors	Array of Healthmonitors objects	Muestra las comprobaciones de estado. Para más detalles, consulte Tabla 4.

**Tabla 4** Descripción de parámetro **healthmonitor**
Parámetro	Tipo	Descripción
id	String	Especifica el ID de comprobación de estado.
tenant_id	String	Especifica el ID del proyecto en el que se realiza la comprobación de estado.
project_id	String	Especifica el ID del proyecto al que pertenece la comprobación de estado. Este parámetro tiene el mismo significado que tenant_id.
name	String	Especifica el nombre de la comprobación de estado.
delay	Integer	Especifica el tiempo máximo entre comprobaciones de estado en la unidad de segundo. El valor varía de 1 a 50.
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.
pools	Array of Pools objects	Muestra los ID de los grupos de servidores backend asociados a la comprobación de estado. Para más detalles, consulte Tabla 6.
admin_state_up	Boolean	Especifica el estado administrativo de la comprobación de estado. Este parámetro está reservado. El valor puede ser true o false. true: habilitar false: deshabilitar
timeout	Integer	Especifica la duración del tiempo de espera de comprobación de estado en la unidad de segundo. El valor varía de 1 a 50. NOTA: Se recomienda establecer el valor menor que el de parámetro delay.
type	String	Especifica el protocolo de comprobación de estado. El valor puede ser TCP, UDP_CONNECT o HTTP.
monitor_port	Integer	Especifica el puerto de comprobación de estado. El número de puerto se encuentra dentro del rango de 1 a 65535. El valor se deja en blanco de forma predeterminada, lo que indica que el puerto del servidor backend se utiliza como puerto de comprobación de estado.
expected_codes	String	Especifica el código de estado HTTP esperado. Las siguientes opciones están disponibles: Un valor único, como 200 Una lista de valores, como 200,202 Un rango de valores, como 200–204 Este parámetro solo tiene efecto cuando el valor de type se establece en HTTP. Actualmente, este parámetro no es compatible y se fija en 200.
domain_name	String	Especifica el nombre de dominio de las solicitudes HTTP durante la comprobación de estado. Este parámetro solo tiene efecto cuando el valor de type se establece en HTTP. El valor se deja en blanco de forma predeterminada, lo que indica que la dirección IP privada del balanceador de carga se utiliza como la dirección de destino de las solicitudes HTTP. El valor puede contener solo dígitos, letras, guiones (-) y puntos (.) y debe comenzar con un dígito o letra, por ejemplo:www.test.com.
url_path	String	Especifica la ruta de solicitud HTTP para la comprobación de estado. El valor predeterminado es /. El valor comienza con una barra (/). Este parámetro solo tiene efecto cuando el valor de type se establece en HTTP. Un valor de ejemplo es /test.
http_method	String	Especifica el método de solicitud HTTP. El valor predeterminado es GET. El valor puede ser GET, HEAD, POST, PUT, DELETE, TRACE, OPTIONS, CONNECT, o PATCH. Este parámetro solo tiene efecto cuando el valor de type se establece en HTTP. NOTA: Este parámetro está reservado.

**Tabla 5** Descripción del parámetro **pools**
Parámetro	Obligatorio	Tipo	Descripción
id	Sí	String	Especifica el ID del grupo de servidores backend.

Ejemplo de la solicitud

Ejemplo de solicitud 1: Consulta de todas las comprobaciones de estado

GET https://{Endpoint}/v2/601240b9c5c94059b63d484c92cfe308/elb/healthmonitors

Ejemplo de solicitud 2: consulta de comprobaciones de estado HTTP

GET https://{Endpoint}/v2/601240b9c5c94059b63d484c92cfe308/elb/healthmonitors?type=HTTP

Ejemplo de la respuesta

Ejemplo de respuesta 1

{
    "healthmonitors": [
        {
            "monitor_port": null,
            "name": "",
            "admin_state_up": true,
            "tenant_id": "601240b9c5c94059b63d484c92cfe308",
            "project_id": "601240b9c5c94059b63d484c92cfe308", 
            "domain_name": null,
            "delay": 5,
            "expected_codes": "200",
            "max_retries": 3,
            "http_method": "GET",
            "timeout": 10,
            "pools": [
                {
                    "id": "caef8316-6b65-4676-8293-cf41fb63cc2a"
                }
            ],
            "url_path": "/",
            "type": "HTTP",
            "id": "1b587819-d619-49c1-9101-fe72d8b361ef"
        }
    ]
}

Ejemplo de respuesta 2

{
    "healthmonitors": [
        {
            "monitor_port": null,
            "name": "",
            "admin_state_up": true,
            "tenant_id": "601240b9c5c94059b63d484c92cfe308",
            "project_id": "601240b9c5c94059b63d484c92cfe308", 
            "domain_name": null,
            "delay": 5,
            "expected_codes": "200",
            "max_retries": 3,
            "http_method": "GET",
            "timeout": 10,
            "pools": [
                {
                    "id": "caef8316-6b65-4676-8293-cf41fb63cc2a"
                }
            ],
            "url_path": "/",
            "type": "HTTP",
            "id": "1b587819-d619-49c1-9101-fe72d8b361ef"
        }
    ]
}