1. Interface Description
Interface request domain name: as.api3.convergecloud.com.
This API (SetInstancesProtection) is used to configure scale-in protection for instances.
When scale-in protection is enabled for an instance, the instance will not be removed in scale-in activities triggered when unhealthy instances are replaced, the alarm threshold is reached, or the desired capacity is changed.
Default interface request rate limit: 20 times per second.
Interface update time: 2019-10-31 18:36:16.
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: SetInstancesProtection |
| 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 |
| AutoScalingGroupId | Yes | No | String | ID of the scaling group. Example: asg-2umy3jbd |
| InstanceIds | Yes | No | Array of String | Instance ID. Example: ["ins-b2d33ywt\n"] |
| ProtectedFromScaleIn | Yes | No | Bool | Specifies whether to enable scale-in protection. Example: true |
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 |
|---|---|
| ResourceNotFound.AutoScalingGroupIdNotFound | The scaling group does not exist. |
| ResourceNotFound.InstancesNotInAutoScalingGroup | The target instance is not in the auto scaling group. |