UpgradeLifecycleHook

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

UpgradeLifecycleHook

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 upgrade the lifecycle hook.

This API is used to upgrade the lifecycle hook, adopting a "comprehensive overwrite" style. Regardless of how the previous parameters were set, it uniformly uses the new configurations for API parameters. For optional fields, if they are not filled in, default values will be used.

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: UpgradeLifecycleHook.
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 call the api DescribeLifecycleHooks and retrieve the LifecycleHookId from the returned information to obtain the lifecycle hook ID.
LifecycleHookName	Yes	String	Lifecycle hook name, which can contain chinese characters, letters, numbers, underscores (_), hyphens (-), and periods (.) with a maximum length of 128 characters.
LifecycleTransition	Yes	String	Scenario for performing 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 are as follows:. Default value, means CONTINUE to execute capacity expansion or reduction. * ABANDON: for scale-out hooks, cvms that time out or fail to execute LifecycleCommand will be released directly or removed. for scale-in hooks, scale-in activities will continue.
HeartbeatTimeout	No	Integer	The maximum length of time (in seconds) that can elapse before the lifecycle hook times out. Value range: 30-7200. Default value: 300
NotificationMetadata	No	String	Additional information sent by auto scaling to notification targets, used when configuring a notification (default value: ""). NotificationMetadata and LifecycleCommand are mutually exclusive parameters and cannot be specified simultaneously.
NotificationTarget	No	NotificationTarget	Notification result. `NotificationTarget` and `LifecycleCommand` cannot be specified at the same time.
LifecycleTransitionType	No	String	The scenario where the lifecycle hook is applied. `EXTENSION`: the lifecycle hook will be triggered when AttachInstances, DetachInstances or RemoveInstaces is called. `NORMAL`: the lifecycle hook is not triggered by the above APIs.
LifecycleCommand	No	LifecycleCommand	Remote command execution object. `NotificationMetadata`, `NotificationTarget`, and `LifecycleCommand` are mutually exclusive and cannot be specified simultaneously.

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 Upgrading a lifecycle hook

Input Example

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

{
    "DefaultResult": "CONTINUE",
    "LifecycleHookName": "hook-updated",
    "LifecycleHookId": "ash-8azjzxj9",
    "LifecycleTransition": "INSTANCE_LAUNCHING",
    "HeartbeatTimeout": "240"
}

Output Example

{
    "Response": {
        "RequestId": "db656d36-ed6b-4795-bdc4-94e7a7e04acb"
    }
}

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	An internal error occurred.
InternalError.CallCmqError	The CMQ API call failed.
InternalError.CallStsError	The STS API call failed.
InternalError.CallTATError	Failed to call the Tencent Automation Tools (TAT) API.
InvalidParameter	Invalid parameter.
InvalidParameter.ActionNotFound	Invalid Action request.
InvalidParameter.Conflict	Multiple parameters specified conflict and cannot co-exist.
InvalidParameterValue	Wrong parameter value.
InvalidParameterValue.Filter	Invalid filter.
InvalidParameterValue.InvalidLifecycleHookId	Invalid lifecycle hook ID.
InvalidParameterValue.LifecycleHookNameDuplicated	The lifecycle hook name already exists.
MissingParameter	Parameter missing.
ResourceNotFound.CommandNotFound	The command does not exist.
ResourceNotFound.LifecycleHookNotFound	The specified lifecycle hook was not found.
ResourceUnavailable.CmqTopicHasNoSubscriber	There are no subscribers for the specified CMQ topic.
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