tencent cloud



Last updated: 2023-04-13 10:03:29

1. API Description

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

This API is used to disable the specified auto-scaling group.

  • When a scaling group is disabled, the following activities are not triggered automatically:
    • Scaling activities triggered alert policies
    • Scaling activities triggered by desired group capacity
    • Replacement of unhealthy instances
    • Scheduled actions
  • When the scaling group is disabled, you can trigger scaling activities manually, including:
    • Scale out to the specify number of instances (ScaleOutInstances)
    • Scale in to the specify number of instances (ScaleInInstances)
    • Remove instances from the scaling group (DetachInstances)
    • Delete instances from the scaling group (RemoveInstances)
    • Add instances to a scaling group (AttachInstances)
    • Shut down CVM instances in a scaling group (StopAutoScalingInstances)
    • Start up CVM instances in a scaling group (StartAutoScalingInstances)

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: DisableAutoScalingGroup.
Version Yes String Common Params. The value used for this API: 2018-04-19.
Region No String Common Params. This parameter is not required for this API.
AutoScalingGroupId Yes String Scaling group ID

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 Disabling the specified scaling group

Input Example

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

    "AutoScalingGroupId": "asg-nvnlpbb8"

Output Example

    "Response": {
        "RequestId": "aa9ead18-44c8-42a8-a68b-ac6206969c2c"

5. Developer Resources


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
InternalError An internal error occurred.
InvalidParameter.ActionNotFound Invalid Action request.
InvalidParameterValue.InvalidAutoScalingGroupId Invalid scaling group ID.
ResourceNotFound.AutoScalingGroupNotFound The scaling group does not exist.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support