Calling Back an Instance Lifecycle Hook

Function

This interface is used to call back the lifecycle hook specified by a scaling instance based on the lifecycle action key or based on the instance ID and lifecycle hook name.

• If your custom operations were successful before the timeout duration elapses, select Abandon or Continue to complete the lifecycle action.
• If you require more time to complete your custom operations, select Extend Timeout to enable the instance to remain in a wait state for an additional hour.
• The callback operation can be performed only when the lifecycle hook of the target instance is in HANGING state.

URI

PUT /autoscaling-api/v1/{project_id}/scaling_instance_hook/{scaling_group_id}/callback

Request Message

• Request parameters

  Table 2 Request parameters

  Parameter	Mandatory	Type	Description
  lifecycle_action_key	No	String	Specifies the lifecycle operation token, which is obtained by calling the API for querying instance suspension. When specifying a lifecycle callback object, this field is mandatory if the instance_id parameter is not used. If both this parameter and the instance_id parameter are used, preferentially use this parameter for callback.
  instance_id	No	String	Specifies the instance ID. When a lifecycle callback object is specified, this parameter is mandatory if the lifecycle_action_key parameter is not used.
  lifecycle_hook_name	No	String	Specifies the lifecycle hook name. When a lifecycle callback object is specified, this parameter is mandatory if the lifecycle_action_key parameter is not used.
  lifecycle_action_result	Yes	String	Specifies the lifecycle callback action. ABANDON: terminates the instance. CONTINUE: continues the instance. EXTEND: extends the timeout duration, one hour each time.

• Example request
  This example shows how to use lifecycle token 23880867-6288-4470-98a8-f8bda096b6c4 in the AS group with ID e5d27f5c-dd76-4a61-b4bc-a67c5686719a to perform the ABANDON callback operation.

  PUT https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_instance_hook/e5d27f5c-dd76-4a61-b4bc-a67c5686719a/callback
  
  {
      "lifecycle_action_result": "ABANDON",
      "lifecycle_action_key":"23880867-6288-4470-98a8-f8bda096b6c4"
  }

Response Message

• Response parameters

  None

• Example response

  None

Returned Values

• Normal

  204

• Abnormal

  Returned Value	Description
  400 Bad Request	The server failed to process the request.
  401 Unauthorized	You must enter the username and password to access the requested page.
  403 Forbidden	You are forbidden to access the requested page.
  404 Not Found	The server could not find the requested page.
  405 Method Not Allowed	You are not allowed to use the method specified in the request.
  406 Not Acceptable	The response generated by the server could not be accepted by the client.
  407 Proxy Authentication Required	You must use the proxy server for authentication so that the request can be processed.
  408 Request Timeout	The request timed out.
  409 Conflict	The request could not be processed due to a conflict.
  500 Internal Server Error	Failed to complete the request because of an internal service error.
  501 Not Implemented	Failed to complete the request because the server does not support the requested function.
  502 Bad Gateway	Failed to complete the request because the request is invalid.
  503 Service Unavailable	Failed to complete the request because the system is unavailable.
  504 Gateway Timeout	A gateway timeout error occurred.

Error Codes

See Error Codes.