Last updated: 2022-01-18 11:13:36

1. API Description

Domain name for API request:

This API (CompleteLifecycleAction) is used to complete a lifecycle action.

  • The result ("CONTINUE" or "ABANDON") of a specific lifecycle hook can be specified by calling this API. If this API is not called at all, the lifecycle hook will be processed based on the "DefaultResult" after timeout.

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.
This document describes the parameters for Signature V1. It's recommended to use the V3 signature, which provides higher security. Note that for Signature V3, the common parameters need to be placed in the HTTP Header. See details.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: CompleteLifecycleAction.
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
LifecycleActionResult Yes String Result of the lifecycle action. Value range: "CONTINUE", "ABANDON"
InstanceId No String Instance ID. Either "InstanceId" or "LifecycleActionToken" must be specified
LifecycleActionToken No String Either "InstanceId" or "LifecycleActionToken" must be specified

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

Input Example
<Common request parameters>

Output Example

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

Example2 Completing a lifecycle action by specifying the LifecycleActionToken

Input Example
<Common request parameters>

Output Example

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

5. Developer Resources


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.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.
ResourceUnavailable.LifecycleActionResultHasSet The lifecycle action has already been set.