开发者社区 问答 正文

查询生命周期挂钩



查询一个或多个满足指定条件的生命周期挂钩列表(DescribeLifecycleHooks)。

描述


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


  • 指定一个生命周期挂钩 ID 列表(LifecycleHookIds.N),此时将忽略 ScalingGroupId 和 LifecycleHookName 参数。

  • 指定伸缩组 ID(ScalingGroupId)。

  • 同时指定伸缩组 ID(ScalingGroupId)和生命周期挂钩名称(LifecycleHookName)。


请求参数

名称类型是否必需描述
ActionString系统规定参数,取值:DescribeLifecycleHooks
LifecycleHookIds.NString生命周期挂钩 ID 列表,N 的取值范围:[1, 50]。
ScalingGroupIdString伸缩组 ID。
LifecycleHookNameString生命周期挂钩名称。
PageNumberInteger实例状态列表的页码。起始值:1,默认值:1。
PageSizeInteger分页查询时设置的每页行数。最大值:50,默认值:50。


返回参数

名称类型描述
RequestIdString请求 ID。
PageNumberInteger查询起始页数。
PageSizeString查询每页返回行数。
TotalCountString生命周期挂钩总个数。
LifecycleHooksLifecycleHookModelSet生命周期挂钩信息列表。


LifecycleHookModelSet

名称类型描述
ScalingGroupIdString伸缩组 ID。
LifecycleHookIdString生命周期挂钩 ID。
LifecycleHookNameString生命周期挂钩名称。
DefaultResultString等待状态结束后的下一步动作。
HeartbeatTimeoutInteger生命周期挂钩为伸缩组活动设置的等待时间,等待状态超时后会执行下一步动作。
LifecycleTransitionString生命周期挂钩对应伸缩活动类型。
NotificationMetadataString伸缩活动的等待状态的固定字符串信息。
NotificationArnString生命周期挂钩通知对象标识符。


示例



请求示例

  1. http://ess.aliyuncs.com/?Action=DescribeLifecycleHooks
  2. &ScalingGroupId=asg-xxxxx
  3. &<公共请求参数>


返回示例


XML 格式
  1. <DescribeLifecycleHooksResponse>
  2.   <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>
  3.   <PageNumber>1</PageNumber>
  4.   <PageSize>50</PageSize>
  5.   <TotalCount>1</TotalCount>
  6.   <LifecycleHooks>
  7.     <LifecycleHook>
  8.       <ScalingGroupId>asg-xxx</ScalingGroupId>
  9.       <LifecycleHookId>ash-xxx</LifecycleHookId>
  10.       <LifecycleHookName>Test</LifecycleHookName>
  11.       <DefaultResult>CONTINUE</DefaultResult>
  12.       <HeartbeatTimeout>60</HeartbeatTimeout>
  13.       <LifecycleTransition>SCALE_OUT</LifecycleTransition>
  14.       <NotificationMetadata>Test</NotificationMetadata>
  15.       <NotificationArn>acs:ess:cn-hangzhou:1111111111:queue/queue1</NotificationArn>
  16.     </LifecycleHook>
  17.   </LifecycleHooks>
  18. </DescribeLifecycleHooksResponse>

JSON 格式
  1. {
  2.   "lifecycleHooks": [
  3.   {
  4.     "defaultResult": "CONTINUE",
  5.     "heartbeatTimeout": 600,
  6.     "lifecycleHookId": "ash-xxx",
  7.     "lifecycleHookName": "Test",
  8.     "lifecycleTransition": "SCALE_OUT",
  9.     "notificationArn": "acs:ess:cn-hangzhou:1111111111:queue/queue1",
  10.     "notificationMetadata": "Test",
  11.     "scalingGroupId": "asg-xxx"
  12.   }
  13.   ],
  14.   "pageNumber": 1,
  15.   "pageSize": 50,
  16.   "requestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  17.   "totalCount": 1
  18. }


错误码


以下为本接口特有的错误码。更多错误码,请访问 API 错误中心
错误代码错误信息HTTP 状态码说明
InvalidParamterThe specified value of parameter is not valid.400指定的参数值不合法。

展开
收起
青蛙跳 2018-08-17 13:56:38 1507 分享 版权
阿里云 AI 助理回答

查询满足指定条件的生命周期挂钩列表,您可以使用阿里云ECS的DescribeLifecycleHooks API接口。以下是操作指南及参数说明:

查询方式

  1. 指定生命周期挂钩ID列表:提供一个或多个(N 的取值范围:[1, 50])生命周期挂钩ID(LifecycleHookIds.N),此时伸缩组ID(ScalingGroupId)和生命周期挂钩名称(LifecycleHookName)将被忽略。
  2. 指定伸缩组ID:仅提供伸缩组ID(ScalingGroupId)来查询该伸缩组下的所有生命周期挂钩。
  3. 同时指定伸缩组ID与生命周期挂钩名称:精确查询某个特定的生命周期挂钩,需同时提供伸缩组ID(ScalingGroupId)和生命周期挂钩名称(LifecycleHookName)。

请求参数

  • Action(必需): 固定值DescribeLifecycleHooks,表示调用的操作类型。
  • LifecycleHookIds.N(可选): 生命周期挂钩ID列表。
  • ScalingGroupId(可选): 伸缩组ID。
  • LifecycleHookName(可选): 生命周期挂钩名称。
  • PageNumber(可选,默认值为1): 查询结果的页码,起始值为1。
  • PageSize(可选,默认值为50): 每页返回的结果数量,最大不超过50。

返回参数

  • RequestId:请求ID,用于标识本次API调用。
  • PageNumber:实际查询的页码。
  • PageSize:每页实际返回的结果数量。
  • TotalCount:查询到的生命周期挂钩总个数。
  • LifecycleHooks:生命周期挂钩信息列表,包含以下字段:
    • ScalingGroupId:伸缩组ID。
    • LifecycleHookId:生命周期挂钩ID。
    • LifecycleHookName:生命周期挂钩名称。
    • DefaultResult:等待状态结束后的下一步动作。
    • HeartbeatTimeout:挂起等待时间,单位秒。
    • LifecycleTransition:对应的伸缩活动类型。
    • NotificationMetadata:通知消息中携带的自定义元数据。
    • NotificationArn:通知目标的ARN。

示例请求

http://ess.aliyuncs.com/
?Action=DescribeLifecycleHooks
&ScalingGroupId=asg-bp1igpak5ft1flyp****
&LifecycleHookName=lifecyclehook****
&PageNumber=1
&PageSize=50

请根据您的具体需求选择合适的查询方式,并准备相应的参数进行API调用。如果您需要进一步的帮助或遇到问题,请参考阿里云官方文档获取详细指导。

有帮助
无帮助
AI 助理回答生成答案可能存在不准确,仅供参考
0 条回答
写回答
取消 提交回答