文档

ModifyLifecycleHook - 修改一个生命周期挂钩的信息

如果当前伸缩组的生命周期挂钩不能满足业务需求,您无需做删除操作,调用ModifyLifecycleHook,通过待修改生命周期挂钩的ID或名称,伸缩组的ID等参数,修改一个生命周期挂钩的信息,包括生命周期挂钩适用的伸缩活动类型,生命周期挂钩为伸缩组活动设置的等待时间,等待状态结束后的下一步动作等信息。

接口说明

您可以通过以下两种方式指定待修改的生命周期挂钩:

  • 只指定生命周期挂钩 ID(LifecycleHookId),此时将忽略伸缩组 ID(ScalingGroupId)和生命周期挂钩名称(LifecycleHookName)参数。

  • 同时指定伸缩组 ID(ScalingGroupId)与生命周期挂钩名称(LifecycleHookName),因为在一个伸缩组内同一个生命周期挂钩名称是唯一的。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ess:ModifyLifecycleHookWrite
  • 全部资源
    *

请求参数

名称类型必填描述示例值
LifecycleHookIdstring

待修改生命周期挂钩的 ID,用于指定生命周期挂钩。

ash-bp1fxuqyi98w0aib****
ScalingGroupIdstring

伸缩组的 ID,用于指定生命周期挂钩。

asg-bp18p2yfxow2dloq****
LifecycleHookNamestring

待修改生命周期挂钩的名称,用于指定生命周期挂钩。

test_SCAL****
DefaultResultstring

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

  • CONTINUE:继续响应弹性扩张活动或者继续响应弹性收缩活动。
  • ABANDON:直接释放弹性扩张活动创建出来的 ECS 实例或者直接将弹性收缩活动中的 ECS 实例从伸缩组移除。
  • ROLLBACK:针对弹性收缩活动,会拒绝释放 ECS 实例,进行回滚;针对弹性扩张活动,会直接释放创建出来的 ECS 实例,效果同 ABANDON 一样。

当伸缩组发生弹性收缩活动(SCALE_IN)并触发多个生命周期挂钩时,如果一个生命周期挂钩的 DefaultResult 取值为 ABANDON 或 ROLLBACK,且该挂钩等待状态结束时,会提前将其他生命周期挂钩对应的等待状态提前结束。其他情况下,下一步动作均以最后一个结束等待状态的下一步动作为准。

CONTINUE
HeartbeatTimeoutinteger

生命周期挂钩为伸缩组活动设置的等待时间,等待状态超时后会执行下一步动作。取值范围:30~21600,单位:秒。

您可以调用 RecordLifecycleActionHeartbeat 延长 ECS 实例的等待时间,也可以调用 CompleteLifecycleAction 提前结束伸缩活动的等待状态。

600
LifecycleTransitionstring

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

  • SCALE_OUT:伸缩组弹性扩张活动。
  • SCALE_IN:伸缩组弹性收缩活动。
SCALE_IN
NotificationMetadatastring

伸缩活动的等待状态的固定字符串信息。参数长度不能超过 4096 个字符。

弹性伸缩每次推送消息到通知对象时,会同时发送您预先指定的 NotificationMetadata 参数值,便于管理和标记不同类别的通知信息。当您同时指定了 NotificationArn 参数时,NotificationMetadata 参数方可生效。

Test
NotificationArnstring

生命周期挂钩通知对象标识符,设置本参数时支持以下通知方式:

  • 消息服务 MNS 队列,参数取值格式:acs:mns:{region-id}:{account-id}:queue/{queuename}。
  • 消息服务 MNS 主题,参数取值格式:acs:mns:{region-id}:{account-id}:topic/{topicname}。
  • 运维编排 OOS 模板,参数取值格式:acs:oos:{region-id}:{account-id}:template/{templatename}。
  • 事件总线,参数取值格式:acs:eventbridge:{region-id}:{account-id}:eventbus/default。

参数格式中的变量含义如下:

  • region-id:伸缩组所在的地域的 ID。
  • account-id:阿里云账号 ID。
  • queuename:MNS 队列的名称。
  • topicname:MNS 主题的名称。
  • templatename:OOS 模板的名称。
acs:mns:cn-beijing:161456884340****:queue/modifyLifecycleHo****
RegionIdstring

伸缩组所属的地域 ID。

cn-beijing
LifecycleHookStatusstring

修改当前生命周期挂钩的状态,取值范围:

  • Active:表示启动生命周期挂钩。
  • InActive:表示暂停生命周期挂钩。

如果不设置该参数,则当前生命周期挂钩状态保持为原有状态。

说明 生命周期挂钩创建成功后,系统默认为启动状态。
Active

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

示例

正常返回示例

JSON格式

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2022-10-13OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:LifecycleHookStatus