You need to enable JavaScript to run this app.
导航

CreateLifecycleHook

最近更新时间2024.01.16 14:13:14

首次发布时间2022.09.02 08:30:42

调用 CreateLifecycleHook 创建生命周期挂钩。

输入参数

名称类型是否必选示例值描述
ActionStringCreateLifecycleHook要执行的操作,取值:CreateLifecycleHook。
VersionString2020-01-01API的版本,取值为:2020-01-01。
ScalingGroupIdStringscg-ybmssdnnhn5pkgyd****伸缩组ID。您可以调用DescribeScalingGroups查询伸缩组ID。

LifecycleHookName

String

hook01

生命周期挂钩名称,创建后不可修改。取值:

  • 不能以数字、中划线、下划线开头。
  • 只能包含中文、字母、数字、下划线和中划线。
  • 长度限制在1 ~ 128个字符之间。
LifecycleHookTimeoutInteger3600ECS实例保持挂起状态的时间,超时后,自动结束挂起状态,根据执行策略继续执行扩缩容行为。 请您评估自定义操作的处理时间后,设置合适的超时时间。取值:30 ~ 21600(6小时),单位 s,且必须为整数。

LifecycleHookType

String

SCALE_IN

伸缩活动的类型,发生指定类型的伸缩活动时,生命周期挂钩会被触发并挂起ECS实例。
取值:

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

LifecycleHookPolicy

String

CONTINUE

实例挂起状态结束后执行的策略。取值:

  • CONTINUE:继续执行。
  • REJECT:中止后续操作。
  • ROLLBACK:针对弹性收缩活动,会拒绝释放ECS实例,进行回滚;针对弹性扩张活动,效果同REJECT相同。
    执行后实例变更流程的详细介绍请参见执行流程和策略

LifecycleCommand.CommandId

String

cmd-4302d02424c5c8e10281e3a31****

批量作业命令ID,表示触发生命周期挂钩后执行批量作业命令,在实例中安装。

  • 如果命令执行成功,则按照CONTINUE执行挂起结束后的策略。
  • 如果命令执行失败/超时或生命周期挂钩超时,则按照LifecycleHookPolicy参数的配置执行挂起结束后的策略。

说明

关联批量作业前,您需要首先创建所需的运维命令,并确认相关实例已安装批量作业客户端。详细操作请参见挂钩关联批量作业功能介绍

LifecycleCommand.Parameters

String

{"username":"root","password":"123456"}

批量作业命令中的参数和参数值。
参数的个数范围为0~60,且需要注意:

  • 参数不允许为空字符串,最多支持64个字符。
  • 值允许为空字符串。
  • 参数与原始命令内容在Base64编码后,综合长度不能超过16KB。
  • 设置的参数名集合必须为创建命令时定义的参数集的子集。对于未传入的参数,使用默认值代替。

ClientToken

String

333456899ff****

保证请求幂等性。由客户端自动生成一个参数值,确保不同请求间该参数值唯一,避免当调用API超时或服务器内部错误时,客户端多次重试导致重复性操作。取值:
仅支持ASCII字符,且不能超过64个字符。

返回数据

名称类型示例值描述
LifecycleHookIdStringsgh-ybrzhc5ht08hccnm****生命周期挂钩ID。

请求示例

GET /?Action=CreateLifecycleHook&ScalingGroupId=scg-ybqm0b*****e6t&LifecycleHookName=hook01&LifecycleHookTimeout=30&LifecycleHookType=SCALE_OUT&LifecycleHookPolicy=CONTINUE&Version=2020-01-01 HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
ServiceName: auto_scaling

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20220630103407010174235038035F****",
        "Action": "CreateLifecycleHook",
        "Version": "2020-01-01",
        "Service": "auto_scaling",
        "Region": "cn-beijing"
    },
    "Result": {
        "LifecycleHookId": "sgh-ybrzhc5ht08hccnm****"
    }
}