tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

SetInstancesProtection

Last updated: 2024-10-25 15:15:55

    1. API Description

    Domain name for API request: as.tencentcloudapi.com.

    This API is used to enable scale-in protection for an instance.
    When scale-in protection is enabled, the instance will not be removed in scale-in activities triggered by replacement of unhealthy instances, alarm threshold reached, change of desired quantity, etc.

    A maximum of 20 requests can be initiated per second for this API.

    We recommend you to use API Explorer
    Try it
    API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

    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 Params. The value used for this API: SetInstancesProtection.
    Version Yes String Common Params. The value used for this API: 2018-04-19.
    Region Yes String Common Params. 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 to enable scale-in protection for this instance

    3. Output Parameters

    Parameter Name Type Description
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Enabling scale-in protection for an instance

    Input Example

    POST / HTTP/1.1
Host: as.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SetInstancesProtection
<Common request parameters>

{
    "AutoScalingGroupId": "asg-2umy3jbd",
    "ProtectedFromScaleIn": "true",
    "InstanceIds": [
        "ins-b2d33ywt"
    ]
}

    Output Example

    {
    "Response": {
        "RequestId": "5b7168d9-5709-4d69-bd32-880a2f565e33"
    }
}

    5. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    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
    InvalidParameter.ActionNotFound Invalid Action request.
    InvalidParameterValue.InvalidAutoScalingGroupId Invalid scaling group ID.
    InvalidParameterValue.InvalidInstanceId Invalid instance ID.
    InvalidParameterValue.LimitExceeded The value exceeds the limit.
    ResourceNotFound.AutoScalingGroupNotFound The scaling group does not exist.
    ResourceNotFound.InstancesNotInAutoScalingGroup The target instance is not in the auto scaling group.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy