All Products
Search
Document Center

Auto Scaling:RecordLifecycleActionHeartbeat

Last Updated:Jul 03, 2024

Extends the time window during which Elastic Compute Service (ECS) instances stay in a Pending state. If the current time window during which an ECS instance stays in a Pending state is not sufficient for you to complete custom operations on the ECS instance, you can call the RecordLifecycleActionHeartbeat operation to extend the time window. When you call this operation, you can specify lifecycleHookId, lifecycleActionToken, and heartbeatTimeout to extend the time window for the desired ECS instance.

Operation description

You can call this operation only when the desired ECS instance enters a Pending state.
An ECS instance can stay in a Pending state for up to six hours. Each time an ECS instance enters a Pending state, you can extend the time window during which the ECS instance stays in a Pending state up to 20 times.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
lifecycleHookIdstringYes

The ID of the lifecycle hook.

ash-bp1fxuqyi98w0aib****
lifecycleActionTokenstringYes

The action token of the lifecycle hook. You can obtain the token from the details page of the Message Service (MNS) queue specified for the lifecycle hook when the desired ECS instance enters a Pending state.
You can also call the DescribeLifecycleActions operation to obtain the action token of the lifecycle hook.
If you specified an MNS topic for the lifecycle hook, you can obtain the token from the MNS topic.

F324B880-900E-4968-85DD-81691113****
heartbeatTimeoutintegerNo

The time window during which the desired ECS instance stays in a Pending state. When the time window ends, Auto Scaling executes the default action. Valid values: 30 to 21600. Unit: seconds.

After you create a lifecycle hook, you can call this operation to extend the time window during which the desired ECS instance stays in a Pending state. You can also call the CompleteLifecycleAction operation to remove the desired ECS instance from a Pending state ahead of schedule.

Default value: 600.

600
RegionIdstringNo

The region ID of the scaling group.

cn-hangzhou

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history