1. 云计算教程网首页
  2. 阿里云

CreateLifecycleHook

lidazhuang • • 阿里云 • 阅读 517

为一个伸缩组创建生命周期挂钩（`CreateLifecycleHook`）。

描述

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

调试

前往【】在线调试，API Explorer 提供在线调用 API、动态生成 SDK Example 代码和快速检索接口等能力，能显著降低使用云 API 的难度，强烈推荐使用。

请求参数

名称 类型 是否必选 示例值 描述
LifecycleTransition String 是 SCALE_OUT

生命周期挂钩适用的伸缩活动类型。取值范围：

  • SCALE_OUT：伸缩组弹性扩张活动
  • SCALE_IN：伸缩组弹性收缩活动
ScalingGroupId String 是 AG6CQdPU8OKdwLjgZcJ****

伸缩组 ID。

Action String 否 CreateLifecycleHook

系统规定参数。取值：CreateLifecycleHook。

DefaultResult String 否 CONTINUE

等待状态结束后的下一步动作。取值范围：

  • CONTINUE：继续响应弹性扩张活动或者继续响应弹性收缩活动。
  • ABANDON：直接释放弹性扩张活动创建出来的 ECS 实例或者直接将弹性收缩活动中的 ECS 实例从伸缩组移除。

默认值：CONTINUE

当伸缩组发生弹性收缩活动（SCALE_IN）并触发多个生命周期挂钩时，DefaultResult=ABANDON 的生命周期挂钩触发的等待状态结束时，会提前将其它对应的等待状态提前结束。其他情况下，下一步动作均以最后一个结束等待状态的下一步动作为准。

HeartbeatTimeout Integer 否 600

生命周期挂钩为伸缩组活动设置的等待时间，等待状态超时后会执行下一步动作。取值范围：30~21600，单位为秒，默认值：600。创建了生命周期挂钩后，您可以调用 延长 ECS 实例的等待时间，也可以调用 提前结束伸缩活动的等待状态。

LifecycleHook.N.DefaultResult String 否 CONTINUE

等待状态结束后的下一步动作。取值范围：

  • CONTINUE：继续响应弹性扩张活动或者继续响应弹性收缩活动。
  • ABANDON：直接释放弹性扩张活动创建出来的 ECS 实例或者直接将弹性收缩活动中的 ECS 实例从伸缩组移除。

默认值：CONTINUE

当伸缩组发生弹性收缩活动（SCALE_IN）并触发多个生命周期挂钩时，DefaultResult=ABANDON 的生命周期挂钩触发的等待状态结束时，会提前将其它对应的等待状态提前结束。其他情况下，下一步动作均以最后一个结束等待状态的下一步动作为准。

LifecycleHook.N.HeartbeatTimeout Integer 否 600

生命周期挂钩为伸缩组活动设置的等待时间，等待状态超时后会执行下一步动作。取值范围：30~21600，单位为秒，默认值：600。创建了生命周期挂钩后，您可以调用 延长 ECS 实例的等待时间，也可以调用 提前结束伸缩活动的等待状态。

LifecycleHook.N.LifecycleHookName String 否 测试SCALE_OUT

生命周期挂钩名称，不能与当前伸缩组其他生命周期挂钩重名。长度为 2~40 个英文或中文字符，以数字、大小字母或中文开头，可包含数字、下划线（_）、连字符（-）和小数点（.）。 默认值为生命周期挂钩 ID。

LifecycleHook.N.LifecycleTransition String 否 SCALE_OUT

生命周期挂钩适用的伸缩活动类型。取值范围：

  • SCALE_OUT：伸缩组弹性扩张活动
  • SCALE_IN：伸缩组弹性收缩活动
LifecycleHook.N.NotificationArn String 否 acs:ess:cn-hangzhou:1111111111:queue/queue1

生命周期挂钩通知对象标识符。目前我们支持消息服务 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}
LifecycleHook.N.NotificationMetadata String 否 Test

伸缩活动的等待状态的固定字符串信息。参数长度不能超过 128 个字符。弹性伸缩每次推送消息到通知对象时，会同时发送您预先指定的 NotificationMetadata 参数值，便于管理和标记不同类别的通知信息。当您同时指定了 NotificationArn 参数时，NotificationMetadata 参数方可生效。

LifecycleHookName String 否 测试SCALE_OUT

生命周期挂钩名称，不能与当前伸缩组其他生命周期挂钩重名。长度为 2~40 个英文或中文字符，以数字、大小字母或中文开头，可包含数字、下划线（_）、连字符（-）和小数点（.）。 默认值为生命周期挂钩 ID。

NotificationArn String 否 acs:ess:cn-hangzhou:1111111111:queue/queue1

生命周期挂钩通知对象标识符。目前我们支持消息服务 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}
NotificationMetadata String 否 Test

伸缩活动的等待状态的固定字符串信息。参数长度不能超过 128 个字符。弹性伸缩每次推送消息到通知对象时，会同时发送您预先指定的 NotificationMetadata 参数值，便于管理和标记不同类别的通知信息。当您同时指定了 NotificationArn 参数时，NotificationMetadata 参数方可生效。

返回参数

名称 类型 示例值 描述
LifecycleHookId String ash-****

生命周期挂钩 ID。

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

请求 ID。无论调用接口成功与否，我们都会返回请求 ID。

示例

请求示例


http://ess.aliyuncs.com/?Action=CreateLifecycleHook
&ScalingGroupId=AG6CQdPU8OKdwLjgZcJ****
&LifecycleHookName=测试SCALE_OUT
&LifecycleTransition=SCALE_OUT
&NotificationArn=acs:ess:cn-hangzhou:1111111111:queue/queue1
&NotificationMetadata=Test
&<公共请求参数>

正常返回示例

XML 格式 

<CreateLifecycleHookResponse>
  <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
  <LifecycleHookId>ash-****</LifecycleHookId>
</CreateLifecycleHookResponse>

JSON 格式 

{
	"LifecycleHookId":"ash-****",
	"RequestId":"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

错误码

HttpCode

错误码

错误信息

描述

400

InvalidParamter

The specified value of parameter is not valid.

参数值不合法。

400

InvalidNotificationArn

The specified parameter notificationArn is invalid.

指定的 NotificationArn 不合法。

400

UnsupportedNotificationType.CurrentRegion

The notificationType is not supported in the special region which scalingGroup belongs to.

当前地域不支持该通知方式。

400

QueueNotExist

The specified queue does not exist.

指定的 MNS 队列不存在。

400

TopicNotExist

The specified topic does not exist.

指定的 MNS 主题不存在。

400

InvalidLifecycleHookName.Duplicate

The specified value of parameter lifecycleHookName is duplicated.

生命周期挂钩已存在。

400

QuotaExceeded.LifecycleHook

Lifecycle hook quota exceeded in the specified scaling group.

一个伸缩组最多可以创建 6 个生命周期挂钩。

微海报分享

发布者：lidazhuang，转转请注明出处：https://www.cms2.cn/aliyun/4551.html

赞 (0)
打赏 微信扫一扫 微信扫一扫
lidazhuanglidazhuang
0
上一篇 2019年9月3日 am9:26
下一篇 2019年9月3日 am9:26

相关推荐

  • 限制条件 阿里云

    限制条件

    本文主要介绍弹性伸缩的限制条件。 弹性伸缩具有以下限制： 伸缩组内部署在的应用必须无状态并且可横向扩展。 伸缩组内的ECS实例可能会被自动释放，因此不适合保存应用状态信息和相关数据等信息，例如会话记录（Session）、数据库或者日志等。如果有需要，您可以保存状态信息到独立的状态…

    2019年9月3日
  • 弹性伸缩FAQ 阿里云

    弹性伸缩FAQ

    如何避免因某个实例规格库存不足导致扩容失败？ 建议在创建伸缩组的时候设置多可用区（可用区下选择不同的Vswitch），创建伸缩配置的时候选择多实例规格，当某个ECS实例规格在某个可用区没有库存时，弹性伸缩服务会自动切换到有库存的实例规格及可用区进行扩容。更多说明请参考或。 报警任…

    2019年9月3日
  • 阿里云弹性伸缩流程介绍 阿里云

    阿里云弹性伸缩流程介绍

    本文介绍如何通过 API 创建和配置包含定时、动态、自定义、固定模式的整体伸缩方案。 创建完整的弹性伸缩方案，您需要通过以下图中所示步骤来完成（其中前三步为简易的伸缩方案）： 创建伸缩组（CreateScalingGroup），配置伸缩资源的最小值（MinSize）、最大值（Ma…

    2019年9月3日

  • 添加ECS实例

    本文介绍如何手动向伸缩组添加一个ECS实例。 前提条件 手动添加ECS实例前，请确保待添加的ECS实例满足以下条件： 实例必须与伸缩组处于同一个地域。 实例不能已加入到其它伸缩组中。 实例的状态必须是运行中。 实例的网络类型可以为经典网络或专有网络，但有以下限制： 当伸缩组的网络…

    2019年3月21日 • 阿里云
  • 弹性伸缩报警任务 阿里云

    弹性伸缩报警任务

    本文主要介绍弹性伸缩报警任务。 弹性伸缩（Auto Scaling）报警任务是弹性伸缩与云监控服务（CMS）深度合作，提供的一种动态管理伸缩组的方式，类似于弹性伸缩定时任务，弹性伸缩报警任务通过触发您指定的伸缩规则来执行伸缩活动，达到调整伸缩组内实例个数的目的。 定时任务可以在您…

    2019年9月3日
  • 强制干预 阿里云

    强制干预

    本文主要介绍强制干预相关内容。 弹性伸缩服务不会阻止用户从 ECS 控制台删除自动创建的 ECS 实例等强制干预行为。 对于用户的强制干预，弹性伸缩服务的处理方法如下。 资源 强制干预类型 弹性伸缩服务的处理方法 ECS 通过 ECS 控制台或 OpenAPI 强制删除伸缩组里的…

    2019年3月21日

发表评论

邮箱地址不会被公开。 必填项已用*标注

记住昵称、邮箱和网址，下次评论免输入