Calling Back a 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.

URI

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

Table 1 Parameter description

Parameter

Mandatory

Type

Description

project_id

Yes

String

Specifies the project ID.

scaling_group_id

Yes

String

Specifies the AS group ID.

Request

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 uses the lifecycle token 23880867-6288-4470-98a8-f8bda096b6c4 to perform the ABANDON callback operation in the AS group with ID e5d27f5c-dd76-4a61-b4bc-a67c5686719a.
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

None

Example Response

None

Returned Values

Error Codes

See Error Codes.