ModifyLifecycleHook - 修改一个生命周期挂钩--弹性伸缩-火山引擎

文档中心

立即注册

导航

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

最近更新时间：2025.03.06 15:28:08首次发布时间：2022.09.02 08:30:42

修改生命周期挂钩，可选参数如不填则表示不修改。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	ModifyLifecycleHook	要执行的操作，取值：ModifyLifecycleHook。
Version	String	是	2020-01-01	API的版本，取值：2020-01-01。
LifecycleHookId	String	是	sgh-ybrzhc5ht08hccnm****	生命周期挂钩ID。您可以调用DescribeLifecycleHooks接口查询生命周期挂钩ID。
LifecycleCommand.CommandId	String	否	cmd-4302d02424c5c8e10281e3a31****	云助手命令ID，表示触发生命周期挂钩后执行云助手命令，在实例中安装。如果命令执行成功，则按照CONTINUE执行挂起结束后的策略。如果命令执行失败/超时或生命周期挂钩超时，则按照`LifecycleHookPolicy`参数的配置执行挂起结束后的策略。说明关联云助手前，您需要首先创建所需的运维命令，并确认相关实例已安装云助手客户端。详细操作请参见挂钩关联云助手功能介绍。
LifecycleCommand.Parameters	String	否	"username":"root","password":"123456"	云助手命令中的参数和参数值。参数的个数范围为0~60，且需要注意：参数不允许为空字符串，最多支持64个字符。值允许为空字符串。参数与原始命令内容在Base64编码后，综合长度不能超过16KB。设置的参数名集合必须为创建命令时定义的参数集的子集。对于未传入的参数，使用默认值代替。
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=ModifyLifecycleHook&LifecycleHookId=sgh-ybrzhc5ht08hccnm****&Version=2020-01-01 HTTP/1.1
Host: open.volcengineapi.com
X-Date: 20240507T112252Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240507/cn-beijing/auto_scaling/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

返回示例

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

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	MissingParameter.LifecycleHookId	The required parameter LifecycleHookId is not supplied.	生命周期挂钩ID不能为空。
400	LimitExceeded.LifecycleHookName	You've reached the limit on the length of LifecycleHookName.	已达到生命周期挂钩名称长度上限。
400	InvalidLifecycleHookTimeout.Malformed	The specified LifecycleHookTimeout is malformed.	指定生命周期挂钩的超时时间不合法。
400	InvalidLifecycleHookType.Malformed	The specified LifecycleHookType is malformed.	指定的生命周期挂钩关联的伸缩活动类型不合法。
400	InvalidLifecycleHookPolicy.Malformed	The specified LifecycleHookPolicy is malformed.	指定的生命周期挂钩策略不合法。
400	InvalidLifecycleCommandParameters.Malformed	The specified LifecycleCommand Parameters are malformed.	指定云助手命令的参数不合法。
400	MissingParameter.LifecycleCommandParameters	The required parameter LifecycleCommand Parameters[%s] is not supplied.	指定云助手命令的参数不能为空。
400	ErrInvalidLifecycleCommandParameters	The specified LifecycleCommand Parameters [%s] is unsupported.	指定的云助手命令参数不合法。
400	InvalidLifecycleCommandParametersValue	The specified value of LifecycleCommand Parameters [%s] is unsupported.	指定的云助手命令参数值不合法。
404	InvalidLifecycleHookId.NotFound	The specified LifecycleHookId does not exist.	指定的生命周期挂钩ID不存在。
404	InvalidLifecycleCommand.NotFound	The specified LifecycleCommand does not exist.	指定的云助手命令不存在。
409	InvalidLifecycleHookName.Conflict	The specified LifecycleHookeName already exists.	指定生命周期挂钩名称已存在。
500	InternalError	An internal error has occurred.	内部错误，请重试。如果多次尝试失败，请提交工单。