Auto Scaling
- Product Introduction
- Getting Started
- Tutorial
- Launch Configuration
- Scaling Groups
- Creating Notifications
- Expanding and Reducing Capacity
- Troubleshooting
- Practical Tutorial
- Customer Cases
- API Documentation
- Scaling Group APIs
- Launch Configuration APIs
- Making API Requests
- Scaling Group Instances APIs
- Scheduled Action APIs
- Alarm Trigger Policy APIs
- Notification APIs
- Lifecycle Hook APIs
- Instance Refresh APIs
- Other APIs
UpgradeLifecycleHook
Last updated: 2024-12-03 17:50:40
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 |
| LifecycleHookName | Yes | String | Lifecycle hook name |
| LifecycleTransition | Yes | String | Scenario for the lifecycle hook. Value range: "INSTANCE_LAUNCHING", "INSTANCE_TERMINATING" |
| DefaultResult | No | String | Defines the action to be taken by the auto scaling group upon lifecycle hook timeout. Value range: "CONTINUE", "ABANDON". Default value: "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 of a notification that Auto Scaling sends to targets. This parameter is set when you configure a notification (default value: ""). |
| 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. 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 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.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
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
No