Configuración de una comprobación de estado
Función
Esta API se utiliza para configurar una comprobación de estado.
Restricciones
Los grupos de seguridad deben tener reglas que permitan el tráfico 100.125.0.0/16. Si desea utilizar UDP para las comprobaciones de estado, asegúrese de que el protocolo del grupo de servidores backend sea UDP.
URI
POST /v3/{project_id}/elb/healthmonitors
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
project_id |
Sí |
String |
Especifica el ID del proyecto. |
Parámetros de solicitud
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
X-Auth-Token |
Sí |
String |
Especifica el token utilizado para la autenticación IAM. |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
healthmonitor |
Sí |
CreateHealthMonitorOption object |
Especifica la comprobación de estado. |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
admin_state_up |
No |
Boolean |
Especifica el estado administrativo de la comprobación de estado.
|
delay |
Sí |
Integer |
Especifica el intervalo entre comprobaciones de estado, en segundos. El valor varía de 1 a 50. |
domain_name |
No |
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. Mínimo: 1 Máximo: 100 |
expected_codes |
No |
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:
El valor predeterminado es 200. Se pueden consultar varios códigos de estado en el formato de expected_codes=xxx&expected_codes=xxx. Mínimo: 1 Máximo: 64 |
http_method |
No |
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. Mínimo: 1 Máximo: 16 |
max_retries |
Sí |
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 |
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 ONLINE a OFFLINE. El valor varía de 1 a 10, y el valor predeterminado es 3. Mínimo: 1 Máximo: 10 Predeterminado: 3 |
monitor_port |
No |
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 |
No |
String |
Especifica el nombre de la comprobación de estado. Mínimo: 0 Máximo: 255 |
pool_id |
Sí |
String |
Especifica el ID del grupo de servidores backend para el que está configurada la comprobación de estado. |
project_id |
No |
String |
Especifica el ID del proyecto. Mínimo: 1 Máximo: 32 |
timeout |
Sí |
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 |
Sí |
String |
Especifica el protocolo de comprobación de estado. El valor puede ser TCP, UDP_CONNECT, HTTP, o HTTPS.. Nota:
|
url_path |
No |
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. Predeterminado: / Mínimo: 1 Máximo: 255 |
Parámetros de respuesta
Código de estado: 201
Parámetro |
Tipo |
Descripción |
---|---|---|
request_id |
String |
Especifica el ID de la solicitud. El valor se genera automáticamente. |
healthmonitor |
HealthMonitor object |
Especifica la comprobación de estado. |
Parámetro |
Tipo |
Descripción |
---|---|---|
admin_state_up |
Boolean |
Especifica el estado administrativo de la comprobación de estado.
|
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:
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. |
Fin del tiempo de espera |
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:
|
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. |
Ejemplo de las solicitudes
POST https://{ELB_Endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/healthmonitors { "healthmonitor" : { "name" : "My Healthmonitor", "max_retries" : 3, "pool_id" : "488acc50-6bcf-423d-8f0a-0f4184f5b8a0", "type" : "HTTP", "timeout" : 30, "delay" : 1 } }
Ejemplo de las respuestas
Código de estado: 201
Respuesta normal a las solicitudes POST.
{ "request_id" : "0e837340-f1bd-4037-8f61-9923d0f0b19e", "healthmonitor" : { "monitor_port" : null, "id" : "c2b210b2-60c4-449d-91e2-9e9ea1dd7441", "project_id" : "99a3fff0d03c428eac3678da6a7d0f24", "domain_name" : null, "name" : "My Healthmonitor", "delay" : 1, "max_retries" : 3, "pools" : [ { "id" : "488acc50-6bcf-423d-8f0a-0f4184f5b8a0" } ], "admin_state_up" : true, "timeout" : 30, "type" : "HTTP", "expected_codes" : "200", "url_path" : "/", "http_method" : "GET" } }
Códigos de estado
Código de estado |
Descripción |
---|---|
201 |
Respuesta normal a las solicitudes POST. |
Códigos de error
Consulte Códigos de error.