You need to enable JavaScript to run this app.
导航
CreateLifecycleHook - 创建一个生命周期挂钩
最近更新时间:2024.10.18 11:12:57首次发布时间:2022.09.02 08:30:42

创建生命周期挂钩,操作说明和注意事项请参见创建生命周期挂钩

调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

参数
类型
是否必填
示例值
描述
Action
String

CreateLifecycleHook

要执行的操作,取值:CreateLifecycleHook。

Version
String

2020-01-01

API的版本,取值:2020-01-01。

ScalingGroupId
String

scg-ybmssdnnhn5pkgyd****

伸缩组ID。您可以调用DescribeScalingGroups查询伸缩组ID。

ClientToken
String

333456899ff****

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

LifecycleCommand.CommandId
String

cmd-4302d02424c5c8e10281e3a31****

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

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

说明

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

LifecycleCommand.Parameters
String

"username":"root"

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

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

hook01

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

  • 不能以数字、中划线、下划线开头。
  • 只能包含中文、字母、数字、下划线和中划线。
  • 长度限制在1 ~ 128个字符之间。
LifecycleHookPolicy
String

CONTINUE

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

  • CONTINUE:继续执行。
  • REJECT:中止后续操作。
  • ROLLBACK:针对弹性收缩活动,会拒绝释放ECS实例,进行回滚;针对弹性扩张活动,效果同REJECT一样。

说明

执行后实例变更流程的详细介绍请参见执行流程和策略

LifecycleHookTimeout
Integer

3600

ECS实例保持挂起状态的时间,超时后,自动结束挂起状态,根据执行策略继续执行扩缩容行为。 请您评估自定义操作的处理时间后,设置合适的超时时间。取值:30 ~ 21600(6小时),单位 s,且必须为整数。

LifecycleHookType
String

SCALE_IN

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

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

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构

参数
类型
示例值
描述
LifecycleHookId
String

sgh-ybrzhc5ht08hccnm****

生命周期挂钩ID。

请求示例

GET /?Action=CreateLifecycleHook&LifecycleHookName=hook01&LifecycleHookPolicy=CONTINUE&LifecycleHookTimeout=3600&LifecycleHookType=SCALE_IN&ScalingGroupId=scg-ybmssdnnhn5pkgyd****&Version=2020-01-01 HTTP/1.1
Host: open.volcengineapi.com
X-Date: 20240507T112350Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240507/cn-beijing/auto_scaling/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f


返回示例

{
  "ResponseMetadata": {
    "RequestId": "20240507192401191219091142F39ECD",
    "Version": "2020-01-01",
    "Service": "auto_scaling",
    "Region": "cn-beijing"
  },
  "Result": {
    "LifecycleHookId": "sgh-ybrzhc5ht08hccnm****"
  }
}

错误码

您可访问公共错误码,获取更多错误码信息。