tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CompleteLifecycleAction

Last updated: 2024-10-25 15:16:24

    1. API Description

    Domain name for API request: as.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
    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, 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.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.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.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy