ModifyLifecycleHook

Last updated: 2025-10-30 21:28:21

ModifyLifecycleHook

Last updated: 2025-10-30 21:28:21

1. API Description

Domain name for API request: as.intl.tencentcloudapi.com.

This API is used to modify the lifecycle hook.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: ModifyLifecycleHook.
Version	Yes	String	Common Params. The value used for this API: 2018-04-19.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
LifecycleHookId	Yes	String	Lifecycle hook ID. you can get the lifecycle hook ID by calling the api DescribeLifecycleHooks and retrieving the LifecycleHookId from the returned information.
LifecycleHookName	No	String	Lifecycle hook name. Name only supports chinese, english, digits, underscore (_), hyphen (-), decimal point (.), maximum length cannot exceed 128.
LifecycleTransition	No	String	Scenario for entering the lifecycle hook. valid values:. `INSTANCE_LAUNCHING`: the lifecycle hook is being scaled out. `INSTANCE_TERMINATING`: the lifecycle hook is being scaled in.
DefaultResult	No	String	Action to be taken by the scaling group in case of lifecycle hook timeout or LifecycleCommand execution failure. valid values:. Default value means CONTINUE to execute capacity expansion or reduction. * ABANDON: for scale-out hooks, cvms that time out or fail to execute LifecycleCommand are released directly or removed. for scale-in hooks, scale-in activities continue.
HeartbeatTimeout	No	Integer	The maximum length of time (in seconds) that can elapse before the lifecycle hook times out. Value range: 30 - 7,200 seconds.
NotificationMetadata	No	String	Specifies the additional information sent by auto scaling to the notification target. NotificationMetadata and LifecycleCommand are mutually exclusive. the two cannot be specified simultaneously.
LifecycleTransitionType	No	String	The scenario where the lifecycle hook is applied. `EXTENSION`: The lifecycle hook will be triggered when `AttachInstances`, `DetachInstances` or `RemoveInstances` is called. `NORMAL`: The lifecycle hook is not triggered by the above APIs.
NotificationTarget	No	NotificationTarget	Notify the target information. NotificationTarget and LifecycleCommand are mutually exclusive. the two cannot be specified simultaneously.
LifecycleCommand	No	LifecycleCommand	Remote command execution object. `NotificationMetadata`, `NotificationTarget`, and `LifecycleCommand` cannot be specified at the same time.

3. Output Parameters

Parameter Name	Type	Description
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Applying a lifecycle hook after the instance launch

Input Example

POST / HTTP/1.1
Host: as.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyLifecycleHook
<Common request parameters>

{
    "LifecycleHookId": "ash-je1esoo9",
    "LifecycleTransition": "INSTANCE_LAUNCHING"
}

Output Example

{
    "Response": {
        "RequestId": "4942c041-fc7f-4f50-b489-d01cdeb6638f"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
InternalError.CallTATError	Failed to call the Tencent Automation Tools (TAT) API.
InvalidParameter	Invalid parameter.
InvalidParameter.ActionNotFound	Invalid Action request.
InvalidParameterValue	Wrong parameter value.
InvalidParameterValue.Range	The value is outside the specified range.
ResourceNotFound.CmqQueueNotFound	The specified CMQ queue does not exist.
ResourceNotFound.CommandNotFound	The command does not exist.
ResourceNotFound.LifecycleHookNotFound	The specified lifecycle hook was not found.
ResourceNotFound.TDMQCMQQueueNotFound	The TDMQ-CMQ queue doesn't exist.
ResourceNotFound.TDMQCMQTopicNotFound	The TDMQ-CMQ topic doesn't exist.
ResourceUnavailable.TDMQCMQTopicHasNoSubscriber	The TDMQ-CMQ topic is not subscribed.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud