调用DescribeLifecycleHooks查询生命周期挂钩。

接口说明

您可以通过以下三种方式查询生命周期挂钩:

  • 指定一个生命周期挂钩ID列表(LifecycleHookId.N),此时将忽略伸缩组ID(ScalingGroupId)和生命周期挂钩名称(LifecycleHookName)参数。
  • 指定伸缩组ID(ScalingGroupId)。
  • 同时指定伸缩组ID(ScalingGroupId)和生命周期挂钩名称(LifecycleHookName)。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeLifecycleHooks

系统规定参数。取值:DescribeLifecycleHooks

ScalingGroupId String asg-bp1igpak5ft1flyp****

伸缩组的ID。

LifecycleHookName String lifecyclehook****

生命周期挂钩的名称。

PageNumber Integer 1

实例状态列表的页码,起始值:1。

默认值:1。

PageSize Integer 50

分页查询时设置的每页行数,最大值:50。

默认值:50。

RegionId String cn-beijing

伸缩组所属地域的ID。

LifecycleHookId.N String ash-bp1at9ufhmcf9cmy****

生命周期挂钩的ID。

返回数据

名称 类型 示例值 描述
RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

请求ID。

PageNumber Integer 1

查询起始页数。

PageSize Integer 50

查询每页返回行数。

TotalCount Integer 1

生命周期挂钩总个数。

LifecycleHooks Array of LifecycleHook

生命周期挂钩信息列表。

LifecycleHook
DefaultResult String CONTINUE

等待状态结束后的下一步动作。

LifecycleHookId String ash-bp19d1032y9kij96****

生命周期挂钩ID。

LifecycleHookName String lifecyclehook****

生命周期挂钩名称。

LifecycleTransition String SCALE_OUT

生命周期挂钩对应的伸缩活动类型。

NotificationMetadata String Test Lifecycle Hook.

伸缩活动的等待状态的固定字符串信息。

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

生命周期挂钩通知对象标识符,参数格式如下:

  • 未设置通知:acs:ess:{region-id}:{account-id}:null/null。
  • 消息服务MNS队列:acs:mns:{region-id}:{account-id}:queue/{queuename}。
  • 消息服务MNS主题:acs:mns:{region-id}:{account-id}:topic/{topicname}。
  • 运维编排OOS模板:acs:oos:{region-id}:{account-id}:template/{templatename}。

参数格式中的变量含义如下:

  • region-id:伸缩组所在的地域的ID。
  • account-id:阿里云账号ID。
  • queuename:MNS队列的名称。
  • topicname:MNS主题的名称。
  • templatename:OOS模板的名称。
HeartbeatTimeout Integer 60

生命周期挂钩为伸缩组活动设置的等待时间,等待状态超时后会执行下一步动作。

ScalingGroupId String asg-bp1igpak5ft1flyp****

伸缩组ID。

示例

请求示例

http(s)://ess.aliyuncs.com/?Action=DescribeLifecycleHooks
&ScalingGroupId=asg-bp1igpak5ft1flyp****
&LifecycleHookName=lifecyclehook****
&PageNumber=1
&PageSize=50
&LifecycleHookId=["ash-bp1at9ufhmcf9cmy****"]
&RegionId=cn-beijing
&公共请求参数

正常返回示例

XML格式

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格式

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

错误码

访问错误中心查看更多错误码。

HttpCode

错误码

错误信息

描述

400

InvalidParamter

The specified value of parameter is not valid.

指定的参数值不合法。