DescribeLifecycleHooks - Auto Scaling - Alibaba Cloud Documentation Center

Queries lifecycle hooks. If you want to check whether the configurations of your lifecycle hooks are correct or you want to query the details of multiple lifecycle hooks at the same time, you can call the DescribeLifecycleHooks operation. You can specify lifecycle hook IDs or scaling group IDs when you call this operation. This operation returns details such as the default actions, scaling activities, Alibaba Cloud Resource Names (ARNs) of notification recipients, and timeout periods of 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.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

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 IDs of the lifecycle hooks that you want to query.
	string	No	The ID of the lifecycle hook that you want to query.	ash-bp1at9ufhmcf9cmy****
RegionId	string	No	The region ID of the scaling group.	cn-beijing

Response parameters

Parameter	Type	Description	Example
	object	The response information.
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<object>	The details of the lifecycle hooks.
	object	Details of the lifecycle hooks.
DefaultResult	string	The next action that is performed after the lifecycle hook times out.	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 that Auto Scaling sends when the lifecycle hook takes effect.	Test Lifecycle Hook.
NotificationArn	string	The ARN of the notification recipient when the lifecycle hook takes effect. The value of this parameter is in one of the following formats: If you did not specify this parameter, the return value is in the `acs:ess:{region-id}:{account-id}:null/null` format. If you specified a Message Service (MNS) queue as the notification recipient, the return value is in the `acs:mns:{region-id}:{account-id}:queue/{queuename}` format. If you specified an MNS topic as the notification recipient, the return value is in the `acs:mns:{region-id}:{account-id}:topic/{topicname}` format. If you specified a CloudOps Orchestration Service (OOS) template as the notification recipient, the return value is in the `acs:oos:{region-id}:{account-id}:template/{templatename}` format. If you specified an event bus as the notification recipient, the return value is in the `acs:eventbridge:{region-id}:{account-id}:eventbus/default` format. The variables in the preceding formats have the following meanings: region-id: the region ID of your scaling group. account-id: the ID of your Alibaba Cloud. 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 times out. When the lifecycle hook times out, Auto Scaling performs the action that is specified by DefaultResult.	60
ScalingGroupId	string	The ID of the scaling group.	asg-bp1igpak5ft1flyp****
LifecycleHookStatus	string	The status of the lifecycle hook. Valid values: Active: The lifecycle hook is enabled. InActive: The lifecycle hook is disabled.	Active

Examples

Sample success responses

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 Service error codes.

Change history

Change time	Summary of changes	Operation
2022-10-13	The response structure of the API has changed	View Change Details