为伸缩组创建一个或多个生命周期挂钩。
接口说明
接口说明
-
一个伸缩组最多可以创建 6 个生命周期挂钩。创建了生命周期挂钩的伸缩组,在发生伸缩活动时,生命周期挂钩会暂停伸缩活动一段时间,具体等待时长可以通过 HeartbeatTimeout 参数指定。您可以在等待期间进行初始化 ECS 实例配置、获取 ECS 实例数据等操作。
-
弹性扩张活动时,ECS 实例添加至 RDS 实例白名单后进入等待状态,等待状态结束后再加入 SLB 实例后端服务器组。弹性收缩活动时,ECS 实例从 SLB 实例后端服务器组移出后进入等待状态,等待状态结束后再从 RDS 实例白名单移出。
-
生命周期挂钩可以配置通知方式,支持 MNS 主题、MNS 队列和 OOS 模板。如果配置 OOS 模板,您需要为 OOS 服务创建 RAM 角色。具体操作,请参见为 OOS 服务设置 RAM 权限。
如果伸缩组有存量的 ECS 实例,且配置的 OOS 模板用于加入或移出除 RDS 外的其他云数据库白名单,则您必须手动将存量的 ECS 实例加入云数据库的白名单。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
ess:CreateLifecycleHook |
create |
*ScalingGroup
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| ScalingGroupId |
string |
是 |
目标伸缩组的 ID。 |
asg-bp1eyv4qn8ssgv43**** |
| LifecycleHookName |
string |
否 |
生命周期挂钩的名称。不能与当前伸缩组其他生命周期挂钩重名,长度为 2~64 个英文或中文字符,以数字、大小写字母或中文开头,可包含数字、下划线(_)、短划线(-)和半角句号(.)。 默认值为 LifecycleHookId 的值。 |
lifecyclehook**** |
| LifecycleTransition |
string |
是 |
生命周期挂钩适用的伸缩活动类型。取值范围:
|
SCALE_OUT |
| DefaultResult |
string |
否 |
等待状态结束后的下一步动作。取值范围:
当伸缩组发生弹性收缩活动(SCALE_IN)并触发多个生命周期挂钩时,如果一个生命周期挂钩的 默认值:CONTINUE。 |
CONTINUE |
| HeartbeatTimeout |
integer |
否 |
生命周期挂钩为伸缩组活动设置的等待时间,等待状态超时后会执行下一步动作。取值范围:30~21600,单位:秒。 创建了生命周期挂钩后,您可以调用 RecordLifecycleActionHeartbeat 延长 ECS 实例的等待时间,也可以调用 CompleteLifecycleAction 提前结束伸缩活动的等待状态。 默认值:600。 |
600 |
| NotificationMetadata |
string |
否 |
生命周期挂钩暂停伸缩活动时推送给 如果 例如,
说明
|
Test lifecycle hook. |
| NotificationArn |
string |
否 |
生命周期挂钩通知对象标识符,不设置本参数表示不发送通知,设置本参数时支持以下通知方式:
参数格式中的变量含义如下:
|
acs:mns:cn-beijing:161456884340****:queue/modifyLifecycleHo**** |
| LifecycleActionSources |
array |
否 |
生命周期挂钩触发的具体场景。 |
|
|
string |
否 |
生命周期挂钩触发的具体场景。
|
DirectToScalingGroup |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| LifecycleHookId |
string |
生命周期挂钩的 ID。 |
ash-bp1at9ufhmcf9cmy**** |
| RequestId |
string |
请求 ID。 |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3**** |
示例
正常返回示例
JSON格式
{
"LifecycleHookId": "ash-bp1at9ufhmcf9cmy****",
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。