tencent cloud

Feedback

ModifyLifecycleHook

Last updated: 2022-08-17 15:34:19

1. API Description

Domain name for API request: as.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.
LifecycleHookName No String Lifecycle hook name.
LifecycleTransition No String The time when the lifecycle hook is applied. Valid values:
  • INSTANCE_LAUNCHING: After the instance launch
  • INSTANCE_TERMINATING: Before the instance termination
  • DefaultResult No String Actions after the lifecycle hook times out. Valid values:
  • CONTINUE: Continue the scaling activity after the timeout
  • ABANDON: Terminate the scaling activity after the timeout
  • 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 Additional information sent by AS to the notification target.
    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 Information of the notification target.

    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 Applying a lifecycle hook after the instance launch

    Input Example

    POST / HTTP/1.1
    Host: as.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

    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
    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.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.
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support