CreateLifecycleHook_弹性伸缩_API文档-阿里云OpenAPI开发者门户

接口说明

一个伸缩组最多可以创建 6 个生命周期挂钩。创建了生命周期挂钩的伸缩组，在发生伸缩活动时，生命周期挂钩会暂停伸缩活动一段时间，具体等待时长可以通过 HeartbeatTimeout 参数指定。您可以在等待期间进行初始化 ECS 实例配置、获取 ECS 实例数据等操作。

弹性扩张活动时，ECS 实例添加至 RDS 实例白名单后进入等待状态，等待状态结束后再加入 SLB 实例后端服务器组。弹性收缩活动时，ECS 实例从 SLB 实例后端服务器组移出后进入等待状态，等待状态结束后再从 RDS 实例白名单移出。

生命周期挂钩可以配置通知方式，支持 MNS 主题、MNS 队列和 OOS 模板。如果配置 OOS 模板，您需要为 OOS 服务创建 RAM 角色。具体操作，请参见为 OOS 服务设置 RAM 权限。

说明如果伸缩组有存量的 ECS 实例，且配置的 OOS 模板用于加入或移出除 RDS 外的其他云数据库白名单，则您必须手动将存量的 ECS 实例加入云数据库的白名单。

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

ess:CreateLifecycleHook	Create	ScalingGroup acs:ess:{#regionId}:{#accountId}:scalinggroup/{#ScalingGroupId}	无	无

请求参数

字段名称	字段详情
ScalingGroupIdstring	目标伸缩组的 ID。示例值:asg-bp1eyv4qn8ssgv43****参考取值来源: ApplyScalingGroup CreateScalingGroup DescribeScalingGroups DetachServerGroups AttachServerGroups
LifecycleHookNamestring	生命周期挂钩的名称。不能与当前伸缩组其他生命周期挂钩重名，长度为 2~64 个英文或中文字符，以数字、大小写字母或中文开头，可包含数字、下划线（_）、短划线（-）和英文句号（.）。展开详情示例值:lifecyclehook****参考取值来源: DescribeLifecycleHooks
LifecycleTransitionstring	生命周期挂钩适用的伸缩活动类型，取值范围：展开详情示例值:SCALE_OUT参考取值来源: DescribeLifecycleHooks
DefaultResultstring	等待状态结束后的下一步动作，取值范围：展开详情示例值:CONTINUE
HeartbeatTimeoutinteger<int32>	生命周期挂钩为伸缩组活动设置的等待时间，等待状态超时后会执行下一步动作。取值范围：30~21600，单位：秒。展开详情示例值:600
NotificationMetadatastring	生命周期挂钩暂停伸缩活动时推送给 NotificationArn（通知对象）的通知信息，便于管理和标记不同类别的通知信息。必须同时指定 NotificationArn。参数长度不能超过 4096 个字符。展开详情示例值:Test lifecycle hook.
NotificationArnstring	生命周期挂钩通知对象标识符，不设置本参数表示不发送通知，设置本参数时支持以下通知方式：展开详情示例值:acs:mns:cn-beijing:161456884340**:queue/modifyLifecycleHo**参考取值来源: CreateNotificationConfiguration DescribeNotificationConfigurations

返回参数

字段名称	字段详情
RequestIdstring	请求 ID。示例值:473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
LifecycleHookIdstring	生命周期挂钩的 ID。示例值:ash-bp1at9ufhmcf9cmy****

返回示例

变更历史

	变更时间	变更内容概要	操作
	2022-09-09	新增OpenAPI，为伸缩组创建一个或多个生命周期挂钩