tencent cloud

Auto Scaling

Product Introduction
Overview
Strengths
Scenarios
Service Limits
Access Management
Purchase Guide
Getting Started
Creating a Scaling Plan in 5 Minutes
Step 1:Creating a Launch Configuration
Step 2:Creating a Scaling Group
Step 3:Creating a Scaling Policy
Tutorial
Creating Web Services
Creating High-performance Computing Cluster
Creating Servers for Sending Requests
Configuring For High Availability Services
Launch Configuration
Launch Configuration Overview
Creating a Launch Configuration
Viewing Launch Configuration List
Modifying Launch Configurations
Exception Detection
Scaling Groups
Scaling Group Overview
Creating a Scaling Group
Viewing Scaling Group List
Modifying Scaling Groups
Modifying Bound Instances
Adding CLBs
Delete scaling group
Creating Notifications
Creating Scaling Activity Notifications
Specifying Notification Recipients
Expanding and Reducing Capacity
Auto Scaling Lifecycle Hook
Managing Scheduled Actions
Managing an Alarm-triggered Policy
Instance Health Check
Expanding Capacity Manually
Scale-in Process
Viewing Scaling Activities
Suspending and Resuming Scaling
Scale-in Removal Protection
Scaling Activity Cancelled
Scaling Activity Failed
Cooldown Period
Monitoring
Monitor Alarm Metrics
Running Status Check
Scheduled Task
Scheduled Task Execution Time Description
Troubleshooting
Scaling Group Doesn't Work
Scaling Activity Failed
Use Cases
Setting a Fixed Outbound IP Address for Scaling Groups
Deploying Elastic Web Application Service
Enabling Services Upon CVM Start-up
Customer Cases
iCarbonX
API Documentation
History
Introduction
API Category
Making API Requests
Scaling Group APIs
Scaling Group Instances APIs
Launch Configuration APIs
Scheduled Action APIs
Alarm Trigger Policy APIs
Notification APIs
Lifecycle Hook APIs
Instance Refresh APIs
Other APIs
Data Types
Error Codes
FAQs
Contact Us
Glossary
DocumentaçãoAuto ScalingAPI DocumentationLifecycle Hook APIsCompleteLifecycleAction

CompleteLifecycleAction

PDF
Modo Foco
Tamanho da Fonte
Última atualização: 2025-10-30 21:28:23

1. API Description

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

This API is used to complete a lifecycle action by setting the status of lifecycle hook to CONTINUE or ABANDON.

  • If this API is not called, the lifecycle hook goes to the status specified in DefaultResult after the timeout period.

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: CompleteLifecycleAction.
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.
LifecycleActionResult Yes String Describes the result of the lifecycle action. valid values are as follows:.
  • CONTINUE: default value, means continue execution of capacity expansion or reduction
    • .
  • ABANDON: for scale-out hooks, CVM instances with hook timeout or failed LifecycleCommand execution will be released directly or moved; for scale-in hooks, scale-in activities will continue.
    • .
    InstanceId No String One of the parameters InstanceId or LifecycleActionToken is required. you can get the instance ID by logging in to the console or making an api call to DescribeInstances and retrieving the InstanceId from the returned information.
    LifecycleActionToken No String Lifecycle action token. specifies that one of InstanceId or LifecycleActionToken must be filled.
    The method for accessing the parameter is as follows: when the hook of the NotificationTarget parameter is triggered, deliver a message containing the token to the message queue specified in the NotificationTarget parameter. the message queue consumer can obtain the token from the message.

    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 Completing a lifecycle action by specifying the InstanceId

    This example shows you how to complete a lifecycle action of the specific instance by specifying the InstanceId.

    Input Example

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

{
    "InstanceId": "ins-ni8bpmve",
    "LifecycleActionResult": "CONTINUE",
    "LifecycleHookId": "ash-fbjiexz7"
}

    Output Example

    {
    "Response": {
        "RequestId": "d0cf47b9-4236-491c-bfab-106947198afe"
    }
}

    Example2 Completing a lifecycle action by specifying the LifecycleActionToken

    This example shows you how to complete a lifecycle action of the specific instance by specifying the LifecycleActionToken, which is contained in the message sent by the lifecycle hook to TDMQ.

    Input Example

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

{
    "LifecycleActionResult": "CONTINUE",
    "LifecycleHookId": "ash-fbjiexz7",
    "LifecycleActionToken": "4d910016-2590-444d-8f4a-c14940036902"
}

    Output Example

    {
    "Response": {
        "RequestId": "de792ffe-e37e-4f1d-8534-300b555739da"
    }
}

    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
    InternalError An internal error occurred.
    InvalidParameter Invalid parameter.
    InvalidParameter.ActionNotFound Invalid Action request.
    InvalidParameter.Conflict Multiple parameters specified conflict and cannot co-exist.
    InvalidParameter.MustOneParameter A parameter is missing. One of the two parameters must be specified.
    InvalidParameterValue Wrong parameter value.
    InvalidParameterValue.InvalidInstanceId Invalid instance ID.
    InvalidParameterValue.InvalidLifecycleHookId Invalid lifecycle hook ID.
    ResourceNotFound.LifecycleHookInstanceNotFound The instance corresponding to the lifecycle hook does not exist.
    ResourceNotFound.LifecycleHookNotFound The specified lifecycle hook was not found.
    ResourceNotFound.LifecycleHookTokenNotFound The specified lifecycle hook token does not exist.
    ResourceUnavailable.LifecycleActionResultHasSet The lifecycle action has already been set.
    Anterior: CreateLifecycleHookPróximo: ModifyLifecycleHook

    Ajuda e Suporte

    Esta página foi útil?

    comentários