产品概述
产品优势
应用场景
使用限制
访问管理
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.
DefaultResult after the timeout period.A maximum of 20 requests can be initiated per second for this API.
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:. |
| 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. |
| 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. |
InstanceIdThis example shows you how to complete a lifecycle action of the specific instance by specifying the InstanceId.
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"
}{
"Response": {
"RequestId": "d0cf47b9-4236-491c-bfab-106947198afe"
}
}LifecycleActionTokenThis 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.
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"
}{
"Response": {
"RequestId": "de792ffe-e37e-4f1d-8534-300b555739da"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
文档反馈