开发者社区> 问答> 正文

生命周期挂钩:创建生命周期挂钩


为一个伸缩组创建生命周期挂钩(CreateLifecycleHook)。

描述


一个伸缩组最多可以创建 6 个生命周期挂钩。创建了生命周期挂钩的伸缩组,在发生伸缩活动时,生命周期挂钩会暂停伸缩活动一段时间,我们称之为伸缩活动等待状态,具体等待时长您可以通过 HeartbeatTimeout 参数指定。
伸缩活动处于等待状态时,伸缩组弹性扩张活动之前或者弹性收缩活动之前为您保留指定时长的操作时间。您可以在等待期间初始化 ECS 实例配置或者获取 ECS 实例数据等。等待状态的进程在处于加入或移除 RDS 实例 IP 白名单和加入或移除 SLB 实例 IP 白名单之间
我们推荐您利用 消息服务 MNS 主题或者队列创建消息通知,掌握伸缩组内正在启动或者即将释放的 ECS 实例的动态。

请求参数

名称类型是否必需描述
ActionString系统规定参数。取值:CreateLifecycleHook
ScalingGroupIdString伸缩组 ID。
LifecycleHookNameString生命周期挂钩名称,不能与当前伸缩组其他生命周期挂钩重名。长度为 [2, 40] 个英文或中文字符,以数字、大小字母或中文开头,可包含数字、下划线(_)、连字符(-)和小数点(.)。默认值:生命周期挂钩 ID
LifecycleTransitionString生命周期挂钩适用的伸缩活动类型。取值范围:
  • SCALE_OUT:伸缩组弹性扩张活动
  • SCALE_IN:伸缩组弹性收缩活动
HeartbeatTimeoutInteger生命周期挂钩为伸缩组活动设置的等待时间,等待状态超时后会执行下一步动作(DefaultResult)。取值范围:[30, 21600],单位为秒,默认值:600。创建了生命周期挂钩后,您可以调用 RecordLifecycleActionHeartbeat 延长 ECS 实例的等待时间,也可以调用 CompleteLifecycleAction 提前结束伸缩活动的等待状态。
DefaultResultString等待状态结束后的下一步动作。取值范围:
  • CONTINUE:继续响应弹性扩张活动或者继续响应弹性收缩活动。
  • ABANDON:直接释放弹性扩张活动创建出来的 ECS 实例或者直接将弹性收缩活动中的 ECS 实例从伸缩组移除。
默认值:CONTINUE当伸缩组发生弹性收缩活动(SCALE_IN)并触发多个生命周期挂钩时,DefaultResult=ABANDON 的生命周期挂钩触发的等待状态结束时,会提前将其它对应的等待状态提前结束。其他情况下,下一步动作均以最后一个结束等待状态的下一步动作为准。
NotificationArnString生命周期挂钩通知对象标识符。目前我们支持消息服务 MNS 队列或主题,参数取值格式:acs:ess:{region}:{account-id}:{resource-relative-id}。
  • region:伸缩组所在的地域
  • account-id:阿里云账号 ID
例如:
  • MNS 队列:acs:ess:{region}:{account-id}:queue/{queuename}
  • MNS 主题:acs:ess:{region}:{account-id}:topic/{topicname}
NotificationMetadataString伸缩活动的等待状态的固定字符串信息。参数长度不能超过 128 个字符。弹性伸缩每次推送消息到通知对象时,会同时发送您预先指定的 NotificationMetadata 参数值,便于管理和标记不同类别的通知信息。当您同时指定了 NotificationArn 参数时,NotificationMetadata 参数方可生效。


返回参数

名称类型描述
RequestIdString请求 ID
LifecycleHookIdString生命周期挂钩 ID


示例



请求示例

  1. http://ess.aliyuncs.com/?Action=CreateLifecycleHook
  2. &ScalingGroupId=AG6CQdPU8OKdwLjgZcJ2eaQ
  3. &LifecycleHookName=测试SCALE_OUT
  4. &LifecycleTransition=SCALE_OUT
  5. &NotificationArn=acs:ess:cn-hangzhou:1111111111:queue/queue1
  6. &NotificationMetadata=Test
  7. &<公共请求参数>


返回示例


XML 格式
  1. <CreateLifecycleHookResponse>
  2.     <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>
  3.     <LifecycleHookId>ash-xxxxxxxxxxxxxxxxx</LifecycleHookId>
  4. </CreateLifecycleHookResponse>

JSON 格式
  1. {
  2.     "requestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  3.     "lifecycleHookId": "ash-xxxxxxxxxxxxxxxxx"
  4. }


错误码


以下为本接口特有的错误码。更多错误码,请访问 API 错误中心
错误代码错误信息HTTP 状态码说明
InvalidParamterThe specified value of parameter is not valid.400参数值不合法。
InvalidNotificationArnThe specified param “notificationArn” is invalid.400指定的 NotificationArn 不合法。
UnsupportedNotificationType.CurrentRegionThe notificationNotificationType “notificationType” is not supported in the special region which scalingGroup belong to.400当前地域不支持该通知方式。
QueueNotExistThe specified queue does not exist.400指定的 MNS 队列不存在。
TopicNotExistThe specified topic does not exist.400指定的 MNS 主题不存在。
InvalidLifecycleHookName.DuplicateThe specified value of parameter “lifecycleHookName” is duplicated.400生命周期挂钩已存在。
[tr=rgb(239, 251, 255)][td]QuotaExceeded.LifecycleHook Lifecycle hook quota exceeded in the specified scaling group.400一个伸缩组最多可以创建 6 个生命周期挂钩。

展开
收起
青蛙跳 2018-08-17 13:55:44 1705 0
0 条回答
写回答
取消 提交回答
问答排行榜
最热
最新

相关电子书

更多
对象的生命期管理 立即下载
低代码开发师(初级)实战教程 立即下载
阿里巴巴DevOps 最佳实践手册 立即下载