如果伸缩组内生命周期挂钩触发后被挂起的ECS实例的等待时间不能满足您的自定义操作,在ECS实例被挂起状态下,调用RecordLifecycleActionHeartbeat,通过参数:生命周期挂钩的ID、伸缩活动的等待状态标识符、需设置的等待时间,延长挂起时间。
接口说明
只能在ECS实例被挂起的状态下调用该接口来延长等待时间。
ECS实例的等待时间不能超过6小时,每次等待状态最多能被延时20次。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 |
类型 |
是否必选 |
示例值 |
描述 |
Action | String | 是 | RecordLifecycleActionHeartbeat | 系统规定参数。取值:RecordLifecycleActionHeartbeat。 |
lifecycleHookId | String | 是 | ash-bp1fxuqyi98w0aib**** | 生命周期挂钩的ID。 |
lifecycleActionToken | String | 是 | F324B880-900E-4968-85DD-81691113**** | 伸缩活动的等待状态标识符,您可以在实例被挂起的状态下,从生命周期挂钩指定的消息服务队列中,接收消息对应的详情页中获取。 也可以调用DescribeLifecycleActions获取。 还可以从生命周期挂钩指定的消息服务主题中获取该值。 |
heartbeatTimeout | Integer | 否 | 600 | 生命周期挂钩为伸缩组活动设置的等待时间,等待状态超时后会执行默认执行策略。取值范围:30~21600,单位:秒。 创建了生命周期挂钩后,您可以调用本接口延长ECS实例的等待时间,也可以调用CompleteLifecycleAction提前结束伸缩活动的等待状态。 默认值:600。 |
RegionId | String | 否 | cn-hangzhou | 伸缩组所属的地域ID。 |
返回数据
名称 |
类型 |
示例值 |
描述 |
RequestId | String | 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E | 请求ID。 |
示例
请求示例
http(s)://ess.aliyuncs.com/?Action=RecordLifecycleActionHeartbeat
&lifecycleHookId=ash-bp1fxuqyi98w0aib****
&lifecycleActionToken=F324B880-900E-4968-85DD-81691113****
&heartbeatTimeout=600
&RegionId=cn-hangzhou
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<RecordLifecycleActionHeartbeatResponse>
<RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
</RecordLifecycleActionHeartbeatResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}
错误码
访问错误中心查看更多错误码。
HttpCode |
错误码 |
错误信息 |
描述 |
400 |
InvalidParamter |
The specified value of parameter is not valid. |
指定的参数值不合法。 |
400 |
LifecycleHookIdAndLifecycleActionToken.Invalid |
The specified lifecycleActionToken and LifecycleHookId you provided does not match any in process lifecycle action. |
根据指定的lifecycleActionToken无法匹配LifecycleHookId。 |
400 |
LifecycleAction.TimeExceeded |
The specified parameter heartbeatTime exceed lifecycleAction max suspend time. |
等待时间最长不能超过6小时。 |
400 |
LifecycleAction.RecordTimesExceeded |
The specified lifecycleAction exceed lifecycleAction max record times. |
每次等待状态最多能被延时20次。 |