DescribeLifecycleHooks - Auto Scaling - Alibaba Cloud Documentation Center

Queries lifecycle hooks.

Operation Description

You can use one of the following methods to query lifecycle hooks:

Specify a list of lifecycle hook IDs by using the LifecycleHookIds parameter. In this case, you do not need to specify the ScalingGroupId and LifecycleHookName parameters.
Specify the scaling group ID by using the ScalingGroupId parameter.
Specify the scaling group ID by using the ScalingGroupId parameter and the lifecycle hook name by using the LifecycleHookName parameter at the same time.

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All resources is used in the Resource type column of the operation.
Condition keyword: refers to the condition keyword defined by the cloud product itself.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operate	access level	Resource type	conditional keyword	Association operation
ess:DescribeLifecycleHooks	Read	AutoScaling acs:ess:{#regionId}:{#accountId}:scalinggroup/{#ScalingGroupId}	without	without

Request parameters

Parameter	Type	Required	Description	Example
ScalingGroupId	string	No	The ID of the scaling group.	asg-bp1igpak5ft1flyp****
LifecycleHookName	string	No	The name of the lifecycle hook.	lifecyclehook****
PageNumber	integer	No	The number of the page to return. Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Maximum value: 50. Default value: 50.	50
LifecycleHookIds	array	No	The ID of the lifecycle hook.
	string	No	The ID of the lifecycle hook.	ash-bp1at9ufhmcf9cmy****
RegionId	string	No	The region ID of the scaling group.	cn-beijing

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageNumber	integer	The page number of the returned page.	1
PageSize	integer	The number of entries returned per page.	50
TotalCount	integer	The total number of lifecycle hooks.	1
LifecycleHooks	array	Details of the lifecycle hooks.
	object	Details of the lifecycle hooks.
DefaultResult	string	The action that Auto Scaling performs after the lifecycle hook ends.	CONTINUE
LifecycleHookId	string	The ID of the lifecycle hook.	ash-bp19d1032y9kij96****
LifecycleHookName	string	The name of the lifecycle hook.	lifecyclehook****
LifecycleTransition	string	The type of the scaling activity to which the lifecycle hook applies.	SCALE_OUT
NotificationMetadata	string	The fixed string that is included in a notification. Auto Scaling sends the notification when the lifecycle hook takes effect.	Test Lifecycle Hook.
NotificationArn	string	The Alibaba Cloud Resource Name (ARN) of the method that is used by Auto Scaling to send notifications when the lifecycle hook takes effect. Specify the value in one of the following formats: If you do not create a notification rule, specify the value in the `acs:ess:{region-id}:{account-id}:null/null` format. If you specify a Message Service (MNS) queue as the notification method, specify the value in the `acs:mns:{region-id}:{account-id}:queue/{queuename}` format. If you specify an MNS topic as the notification method, specify the value in the `acs:mns:{region-id}:{account-id}:topic/{topicname}` format. If you specify an Operation Orchestration Service (OOS) template as the notification method, specify the value in the `acs:oos:{region-id}:{account-id}:template/{templatename}` format. The variables in the preceding parameter formats have the following meanings: region-id: the region ID of the scaling group. account-id: the ID of the Alibaba Cloud account. queuename: the name of the MNS queue. topicname: the name of the MNS topic. templatename: the name of the OOS template.	acs:ess:cn-beijing:161456884340****:null/null
HeartbeatTimeout	integer	The period of time before the lifecycle hook ends. Auto Scaling performs the specified action after the lifecycle hook ends.	60
ScalingGroupId	string	The ID of the scaling group.	asg-bp1igpak5ft1flyp****
LifecycleHookStatus	string	The status of the lifecycle hook. Valid values: Active InActive	Active

Example

Normal return example

JSONFormat

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PageNumber": 1,
  "PageSize": 50,
  "TotalCount": 1,
  "LifecycleHooks": [
    {
      "DefaultResult": "CONTINUE",
      "LifecycleHookId": "ash-bp19d1032y9kij96****",
      "LifecycleHookName": "lifecyclehook****",
      "LifecycleTransition": "SCALE_OUT",
      "NotificationMetadata": "Test Lifecycle Hook.",
      "NotificationArn": "acs:ess:cn-beijing:161456884340****:null/null",
      "HeartbeatTimeout": 60,
      "ScalingGroupId": "asg-bp1igpak5ft1flyp****",
      "LifecycleHookStatus": "Active"
    }
  ]
}

Error codes

For a list of error codes, visit the API error center.

Change history

Change time

Summary of changes

Operate

2022-10-13

The response structure of the API operation has changed

Change item	Change content
Output Parameters	The response structure of the API operation has changed