RecordLifecycleActionHeartbeat - Auto Scaling - Alibaba Cloud Documentation Center

Operation description

You can call this operation to extend the wait time only when the ECS instance is in the suspended state.

The wait time of an ECS instance cannot exceed 6 hours, and each wait state can be extended up to 20 times.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ess:RecordLifecycleActionHeartbeat

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
lifecycleHookId	string	Yes	The ID of the lifecycle hook.	ash-bp1fxuqyi98w0aib****
lifecycleActionToken	string	Yes	The token that indicates the wait state of the scaling activity. You can obtain this token from the details of the message received from the Simple Message Queue (formerly MNS) queue specified by the lifecycle hook when the instance is in the suspended state. You can also call DescribeLifecycleActions to obtain this token. Alternatively, you can obtain this value from the Simple Message Queue (formerly MNS) topic specified by the lifecycle hook.	F324B880-900E-4968-85DD-81691113****
heartbeatTimeout	integer	No	The wait time that the lifecycle hook sets for the scaling group activity. After the wait state times out, the default policy is executed. Valid values: 30 to 21600. Unit: seconds. After a lifecycle hook is created, you can call this operation to extend the wait time of the ECS instance, or call CompleteLifecycleAction to end the wait state of the scaling activity in advance. Default value: 600.	600
RegionId	string	No	The region ID of the scaling group.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.