UpgradeLifecycleHook

Last updated: 2020-03-16 10:38:16

PDF

1. API Description

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

This API (UpgradeLifecycleHook) is used to upgrade a lifecycle hook.

  • This API is used to upgrade a lifecycle hook in a "completely overriding" manner, i.e., it uniformly sets a new configuration according to the API parameters regardless of the original parameters. If optional fields are left empty, their default values will be used.

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

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: as.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: UpgradeLifecycleHook.
Version Yes String Common parameter. The value used for this API: 2018-04-19.
Region Yes String Common parameter. 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-3,600. Default value: 300
NotificationMetadata No String Additional information sent by AS to the notification target. The default value is ''
NotificationTarget No NotificationTarget Notification target
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.

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Upgrading a Lifecycle Hook

Input Example

https://as.tencentcloudapi.com/?Action=UpgradeLifecycleHook
&LifecycleHookId=ash-8azjzxj9
&DefaultResult=CONTINUE
&HeartbeatTimeout=240
&LifecycleHookName=hook-updated
&LifecycleTransition=INSTANCE_LAUNCHING
&<common request parameters>

Output Example

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

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

SDK

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

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 Internal error.
InvalidParameter Invalid parameter.
InvalidParameter.Conflict Multiple parameters specified conflict and cannot co-exist.
InvalidParameterValue Wrong parameter value.
InvalidParameterValue.Filter Invalid filter.
InvalidParameterValue.LifecycleHookNameDuplicated The lifecycle hook name already exists.
MissingParameter Missing parameter.
ResourceNotFound.LifecycleHookNotFound The specified lifecycle hook was not found.