1. Interface Description
Interface request domain name: as.api3.convergecloud.com.
This API (CompleteLifecycleAction) is used to complete a lifecycle action.
- You can call this API to specify a result ("CONTINUE" or "ABANDON") for a lifecycle hook. If this API is not called at all, the lifecycle hook will be processed based on the "DefaultResult" after the timeout period elapses.
Default interface request rate limit: 20 times per second.
Interface update time: 2019-10-31 18:28:51.
The interface only verifies the signature but does not authenticate.
2. Input Parameters
The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.
| Parameter name | Required | Allow NULL | Type | Description |
|---|---|---|---|---|
| Action | Yes | No | String | Public parameter, The value of this interface: CompleteLifecycleAction |
| Version | Yes | No | String | Public parameter, The value of this interface: 2018-04-19 |
| Region | No | No | String | Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface |
| LifecycleHookId | Yes | No | String | Lifecycle hook ID. Example: ash-fbjiexz7 |
| InstanceId | No | No | String | Instance ID. You must specify at least one of the InstanceId and LifecycleActionToken parameters.Example: ins-ni8bpmve |
| LifecycleActionToken | No | No | String | You must specify at least one of the InstanceId and LifecycleActionToken parameters.Example: 4d910016-2590-444d-8f4a-c14940036902 |
| LifecycleActionResult | Yes | No | String | Result of the lifecycle action. Valid values: CONTINUE and ABANDON. Example: CONTINUE |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| RequestId | String | Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem. |
4. Error Code
The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.
| Error Code | Description |
|---|---|
| ResourceUnavailable.LifecycleActionResultHasSet | The lifecycle action has already been set. |
| InvalidParameter | Parameter error. |
| ResourceNotFound.LifecycleHookNotFound | The specified lifecycle hook was not found. |
| ResourceNotFound.LifecycleHookInstanceNotFound | The instance corresponding to the lifecycle hook does not exist. |
| InternalError | Internal error. |
| InvalidParameterValue | The parameter value is invalid. |