Modificación de un gancho de ciclo de vida
Función
Esta interfaz se utiliza para modificar la información sobre un gancho de ciclo de vida especificado.
URI
PUT /autoscaling-api/v1/{project_id}/scaling_lifecycle_hook/{scaling_group_id}/{lifecycle_hook_name}
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
project_id |
Sí |
String |
Especifica el ID del proyecto. |
scaling_group_id |
Sí |
String |
Especifica el ID de grupo AS. |
lifecycle_hook_name |
Sí |
String |
Especifica el nombre del gancho del ciclo de vida. |
Mensaje de solicitud
- Parámetros de solicitud
Tabla 2 Parámetros de solicitud Parámetro
Obligatorio
Tipo
Descripción
lifecycle_hook_type
No
String
Especifica el tipo de gancho del ciclo de vida. Opciones:
- INSTANCE_TERMINATING: el gancho suspende la instancia cuando se termina la instancia.
- INSTANCE_LAUNCHING: el gancho suspende la instancia cuando se inicia la instancia.
default_result
No
String
Especifica la operación de devolución de llamada de gancho del ciclo de vida predeterminada. De forma predeterminada, esta operación se realiza cuando expira el tiempo de espera.
- ABANDON
- CONTINUE
NOTA:- Si se está iniciando una instancia, CONTINUE indica que las operaciones personalizadas se han realizado correctamente y que se puede utilizar la instancia. ABANDON indica que sus operaciones personalizadas fallaron y la instancia se terminará. En tal caso, la acción de ajuste falla y debe crear una nueva instancia.
- Si se detiene una instancia, ABANDON y CONTINUE permiten la terminación de la instancia. La diferencia entre los dos estados es la siguiente: ABANDON detiene otros ganchos de ciclo de vida, pero CONTINUE permite completar otros ganchos de ciclo de vida.
- El valor predeterminado de este parámetro es ABANDON.
default_timeout
No
Integer
Especifica la duración del tiempo de espera del gancho del ciclo de vida, que oscila entre 300 y 86400 en la unidad de segundo. El valor predeterminado es 3600.
De forma predeterminada, este parámetro especifica la duración de espera de la instancia. Puede prolongar el tiempo de espera o realizar la operación CONTINUE o ABANDON antes de que expire el tiempo de espera.
notification_topic_urn
No
String
Especifica un tema único en SMN.
Este parámetro especifica un objeto de notificación para un gancho de ciclo de vida. Cuando el gancho de ciclo de vida suspende una instancia, el servicio SMN envía una notificación al objeto. Esta notificación contiene la información básica de la instancia, el contenido de notificación personalizado y el token para controlar las operaciones del ciclo de vida.
notification_metadata
No
String
Especifica una notificación personalizada, que no contiene más de 256 caracteres de longitud. El mensaje no puede contener los siguientes caracteres: <>&'()
Después de configurar un objeto de notificación, el servicio SMN envía su notificación personalizada al objeto.
- Ejemplo de la solicitud
Este ejemplo muestra cómo cambiar la operación de devolución de llamada del gancho de ciclo de vida denominado test-hook1 en el grupo AS con ID e5d27f5c-dd76-4a61-b4bc-a67c5686719a a CONTINUE.
PUT https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_lifecycle_hook/e5d27f5c-dd76-4a61-b4bc-a67c5686719a/test-hook1 { "default_result": "CONTINUE" }
Mensaje de la respuesta
- Parámetros de respuesta
Tabla 3 Parámetros de respuesta Parámetro
Tipo
Descripción
lifecycle_hook_name
String
Especifica el nombre del gancho del ciclo de vida.
lifecycle_hook_type
String
Especifica el tipo de gancho del ciclo de vida.
- INSTANCE_TERMINATING
- INSTANCE_LAUNCHING
default_result
String
Especifica la operación de devolución de llamada de gancho del ciclo de vida predeterminada.
- ABANDON
- CONTINUE
default_timeout
Integer
Especifica la duración del tiempo de espera del gancho del ciclo de vida en la unidad de segundo.
notification_topic_urn
String
Especifica un tema único en SMN.
notification_topic_name
String
Especifica el nombre del tema en SMN.
notification_metadata
String
Especifica la notificación personalizada.
create_time
String
Especifica la hora a la que se crea el gancho del ciclo de vida. El tiempo es compatible con UTC.
- Ejemplo de la respuesta
{ "lifecycle_hook_name": "test-hook1", "default_result": "CONTINUE", "default_timeout": 3600, "notification_topic_urn": "urn:smn:regionId:b53e5554fad0494d96206fb84296510b:gsh", "notification_topic_name": "gsh", "lifecycle_hook_type": "INSTANCE_LAUNCHING", "notification_metadata": null, "create_time": "2016-11-18T04:01:34Z" }
Valores devueltos
- Normal
- Anormal
Valor devuelto
Descripción
400 Bad Request
Se produjo un error en el servidor al procesar la solicitud.
401 Unauthorized
Debe introducir el nombre de usuario y la contraseña para acceder a la página solicitada.
403 Forbidden
Está prohibido el acceso a la página solicitada.
404 Not Found
No se pudo encontrar la página solicitada.
405 Method Not Allowed
No se le permite utilizar el método especificado en la solicitud.
406 Not Acceptable
El cliente no pudo aceptar la respuesta generada por el servidor.
407 Proxy Authentication Required
Debe utilizar el servidor proxy para la autenticación para que la solicitud pueda procesarse.
408 Request Timeout
Se agotó el tiempo de espera de la solicitud.
409 Conflict
La solicitud no se pudo procesar debido a un conflicto.
500 Internal Server Error
Se produjo un error al completar la solicitud debido a un problema de servicio interno.
501 Not Implemented
Error al completar la solicitud porque el servidor no admite la función solicitada.
502 Bad Gateway
Error al completar la solicitud porque la solicitud no es válida.
503 Service Unavailable
Error al completar la solicitud porque el sistema no está disponible.
504 Gateway Timeout
Se ha producido un error de tiempo de espera de la puerta de enlace.
Códigos de error
Consulte Códigos de error