1. Interface Description
Interface request domain name: as.api3.convergecloud.com.
This API (UpgradeLifecycleHook) is used to upgrade a lifecycle hook.
- This API is used to upgrade a lifecycle hook in a "completely overriding" manner. It uniformly specifies a new configuration based on the request parameters regardless of the original parameter configurations. If optional parameters are left empty, their default values will be used.
Default interface request rate limit: 20 times per second.
Interface update time: 2022-10-14 17:29:24.
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: UpgradeLifecycleHook |
| 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-8azjzxj9 |
| DefaultResult | No | No | String | The action that is taken when the lifecycle hook of the scaling group times out. Valid values: CONTINUE and ABANDON. Default value: CONTINUE. Example: CONTINUE |
| HeartbeatTimeout | No | No | Int64 | Timeout period of the lifecycle hook. Unit: seconds. Valid values: 30 to 3600. Default value: 300. Example: 240 |
| LifecycleHookName | Yes | No | String | Name of the lifecycle hook. Example: hook-updated |
| LifecycleTransition | Yes | No | String | Scenario where the lifecycle hook is used. Valid values: INSTANCE_LAUNCHING and INSTANCE_TERMINATING. Example: INSTANCE_LAUNCHING |
| NotificationMetadata | No | No | String | Additional information that Auto Scaling sends to the notification target. By default, this parameter is left empty. Example: "" |
| NotificationTarget | No | No | NotificationTarget | Notification target Example:View |
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 |
|---|---|
| InvalidParameterValue.LifecycleHookNameDuplicated | The lifecycle hook name already exists. |
| InvalidParameter.Conflict | Multiple parameters specified conflict and cannot co-exist. |
| InvalidParameter | Parameter error. |
| MissingParameter | Parameter missing. |
| InvalidParameterValue.Filter | Invalid filter. |
| ResourceNotFound.LifecycleHookNotFound | The specified lifecycle hook was not found. |
| InternalError | Internal error. |
| InvalidParameterValue | The parameter value is invalid. |
| InternalError.CallTDMQError | TDMQ interface call failed. |
| ResourceNotFound.ResourceNotFoundTDMQPulsarTopicNotFound | TDMQ-Pulsar theme does not exist. |