Use DescribeLifecycleActions to query lifecycle hook actions - Auto Scaling - Alibaba Cloud - Auto Scaling

Queries the details of lifecycle actions triggered by lifecycle hooks during a scaling activity, including the action status, token, and IDs of affected Elastic Compute Service (ECS) instances.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ess:DescribeLifecycleActions

get

*ScalingGroup

acs:ess:{#regionId}:{#accountId}:scalinggroup/{#ScalingGroupId}

None

Request parameters

Parameter	Type	Required	Description	Example
ScalingActivityId	string	Yes	The ID of the scaling activity.	asa-bp17mug9t0pegagw****
LifecycleActionStatus	string	No	The status of the lifecycle action. Valid values: Pending: ECS instances are waiting to be added to or removed from the scaling group. Timeout: The lifecycle hook that triggers the lifecycle action has timed out, and ECS instances are added to or removed from the scaling group. Completed: The lifecycle hook that triggers the lifecycle action is manually ended ahead of schedule.	Pending
NextToken	string	No	The pagination token that specifies the start of the next query. Set this parameter to the NextToken value returned by the previous call. If not specified, the query starts from the beginning.	AAAAAcSz4VTb1Nq****
MaxResults	integer	No	The maximum number of entries to return on each page. Valid values: 1 to 50. Default value: 10.	10
RegionId	string	No	The region ID of the scaling group.	cn-qingdao

Response elements

Element	Type	Description	Example
	object
NextToken	string	The query token returned in this call.	AAAAAcSz4VTb1Nq****
RequestId	string	The ID of the request.	42A742EB-FCF3-459E-9C62-E107048C17E3
TotalCount	integer	The total number of the queried lifecycle actions.	3
MaxResults	integer	The maximum number of entries returned per page.	3
LifecycleActions	array<object>	The actions of the lifecycle hook.
	object	The lifecycle actions.
LifecycleHookId	string	The ID of the lifecycle hook.	ash-bp18uoft0deax0f7****
LifecycleActionToken	string	The token of the lifecycle hook action.	9C2E9DA7-F794-449A-ACF6-CEE24444F7BB
LifecycleActionStatus	string	The status of the lifecycle hook action.	Pending
LifecycleActionResult	string	The subsequent action that Auto Scaling performs after the lifecycle hook times out. Valid values: CONTINUE: Auto Scaling continues to respond to a scale-in or scale-out request. ABANDON: Auto Scaling releases ECS instances that are created during scale-out events, or removes ECS instances from the scaling group during scale-in events.	CONTINUE
InstanceIds	array	The IDs of the ECS instances on which the lifecycle hook takes effect.
	string	The ID of the ECS instance on which the lifecycle hook takes effect.	["i-bp11m3fzlqrgk5vh**","i-bp11m3fzlqrgk5vh**"]

Examples

Success response

JSON format

{
  "NextToken": "AAAAAcSz4VTb1Nq****",
  "RequestId": "42A742EB-FCF3-459E-9C62-E107048C17E3",
  "TotalCount": 3,
  "MaxResults": 3,
  "LifecycleActions": [
    {
      "LifecycleHookId": "ash-bp18uoft0deax0f7****",
      "LifecycleActionToken": "9C2E9DA7-F794-449A-ACF6-CEE24444F7BB",
      "LifecycleActionStatus": "Pending",
      "LifecycleActionResult": "CONTINUE",
      "InstanceIds": [
        "[\"i-bp11m3fzlqrgk5vh****\",\"i-bp11m3fzlqrgk5vh****\"]"
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.