SetInstancesProtection
Last updated: 2019-12-05 14:02:56
Contents：
1. API Description
Domain name for API request: as.tencentcloudapi.com.
This API (SetInstancesProtection) is used to enable scale-in protection for an instance.
When an instance has scale-in protection enabled, it will not be removed when scaling is triggered by replacement of unhealthy instances, alarm trigger policy, threshold change, etc.
A maximum of 20 requests can be initiated per second for this API.
Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: as.ap-shanghai-fsi.tencentcloudapi.com
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 parameter. The value used for this API: SetInstancesProtection |
| Version | Yes | String | Common parameter. The value used for this API: 2018-04-19 |
| Region | Yes | String | Common parameter. For more information, please see the list of regions supported by the product. |
| AutoScalingGroupId | Yes | String | Auto scaling group ID. |
| InstanceIds.N | Yes | Array of String | Instance ID. |
| ProtectedFromScaleIn | Yes | Boolean | Whether the instance needs to be protected from scale-in. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
4. Example
Example1 Setting Scale-in Protection for CVM Instances
Input Example
https://as.tencentcloudapi.com/?Action=SetInstancesProtection
&AutoScalingGroupIds.0=asg-2umy3jbd
&InstanceIds.0=ins-b2d33ywt
&ProtectedFromScaleIn=true
&<Common request parameter>Output Example
{
"Response": {
"RequestId": "5b7168d9-5709-4d69-bd32-880a2f565e33"
}
}5. Developer Resources
API Explorer
This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.
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 |
|---|---|
| ResourceNotFound.AutoScalingGroupIdNotFound | The auto scaling group does not exist. |
| ResourceNotFound.InstancesNotInAutoScalingGroup | The target instance is not in the auto scaling group. |
