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
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. |
| Parameter Name | Type | Description |
|---|---|---|
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://as.tencentcloudapi.com/?Action=SetInstancesProtection
&AutoScalingGroupId=asg-2umy3jbd
&InstanceIds.0=ins-b2d33ywt
&ProtectedFromScaleIn=true
&<Common Request Parameter>{
"Response": {
"RequestId": "5b7168d9-5709-4d69-bd32-880a2f565e33"
}
}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 |
|---|---|
| InvalidParameterValue.InvalidAutoScalingGroupId | Invalid scaling group ID. |
| InvalidParameterValue.InvalidInstanceId | Invalid instance ID. |
| ResourceNotFound.AutoScalingGroupNotFound | The scaling group does not exist. |
| ResourceNotFound.InstancesNotInAutoScalingGroup | The target instance is not in the auto scaling group. |
Was this page helpful?