Queries lifecycle hooks.

Description

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

  • Specify a list of lifecycle hook IDs by using the LifecycleHookId.N 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.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeLifecycleHooks

The operation that you want to perform. Set the value to DescribeLifecycleHooks.

ScalingGroupId String No asg-bp1igpak5ft1flyp****

The ID of the scaling group.

LifecycleHookName String No lifecyclehook****

The name of the lifecycle hook.

PageNumber Integer No 1

The number of the page to return. Pages start from page 1.

Default value: 1.

PageSize Integer No 50

The number of entries to return on each page. Valid values: 1 to 50.

Default value: 50.

RegionId String No cn-beijing

The ID of the region to which the scaling group belongs.

LifecycleHookId.N String No ash-bp1at9ufhmcf9cmy****

The ID of the lifecycle hook.

Response parameters

Parameter Type Example Description
RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

The ID of the request.

PageNumber Integer 1

The page number of the returned page.

PageSize Integer 50

The number of entries returned per page.

TotalCount Integer 1

The total number of lifecycle hooks.

LifecycleHooks Array of LifecycleHook

The details of the lifecycle hooks.

LifecycleHook
DefaultResult String CONTINUE

The subsequent action to take when the lifecycle hook times out.

LifecycleHookId String ash-bp19d1032y9kij96****

The ID of the lifecycle hook.

LifecycleHookName String lifecyclehook****

The name of the lifecycle hook.

LifecycleTransition String SCALE_OUT

The type of the scaling activity to which the lifecycle hook applies.

NotificationMetadata String Test Lifecycle Hook.

The fixed string that is included when Auto Scaling sends a notification that a scaling activity is in the pending state.

NotificationArn String acs:ess:cn-beijing:161456884340****:null/null

The Alibaba Cloud Resource Name (ARN) of the party to which Auto Scaling sends notifications when the lifecycle hook takes effect. The following list describes the value formats of this parameter:

  • If you did not create an event notification, the value format of this parameter is acs:ess:{region-id}:{account-id}:null/null.
  • If the notified party is a Message Service (MNS) queue, the value format of this parameter is acs:mns:{region-id}:{account-id}:queue/{queuename}.
  • If the notified party is an MNS topic, the value format of this parameter is acs:mns:{region-id}:{account-id}:topic/{topicname}.
  • If the notified party is an Operation Orchestration Service (OOS) template, the value format of this parameter is acs:oos:{region-id}:{account-id}:template/{templatename}.

The variables in the preceding formats have the following meanings:

  • region-id: the ID of the region where the scaling group resides.
  • 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.
HeartbeatTimeout Integer 60

The period of time during which the lifecycle hook takes effect. Auto Scaling performs the default action when the lifecycle hook times out.

ScalingGroupId String asg-bp1igpak5ft1flyp****

The ID of the scaling group.

Examples

Sample requests

http(s)://ess.aliyuncs.com/?Action=DescribeLifecycleHooks
&ScalingGroupId=asg-bp1igpak5ft1flyp****
&LifecycleHookName=lifecyclehook****
&PageNumber=1
&PageSize=50
&LifecycleHookId=["ash-bp1at9ufhmcf9cmy****"]
&RegionId=cn-beijing
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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****"
  } ]
}

Error codes

For a list of error codes, visit the API Error Center.

HTTP status code

Error code

Error message

Description

400

InvalidParamter

The specified value of parameter is not valid.

The error message returned because the value that you specified for a parameter is invalid.