Documentation | Tencent Cloud

search by keyword

Recent Pages

Documentation

StopAutoScalingInstances

Last updated: 2021-04-19 14:21:51

1. API Description

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

This API is used to shut down CVM instances in a scaling group.

Use the SOFT_FIRST shutdown, which means the CVM will be forcibly shut down if the soft shutdown fails.
Shutting down instances in the IN_SERVICE status will reduce the desired capacity, but the desired capacity cannot be less than the minimum value.
To use the STOP_CHARGING shutdown, the instances you want to shut down must satisfy the conditions of no charges when shut down.
This API supports batch operation. Up to 100 instances can be shut down in each request.

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

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 parameter. The value used for this API: StopAutoScalingInstances.
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	The scaling group ID.
InstanceIds.N	Yes	Array of String	The list of the CVM instances you want to shut down.
StoppedMode	No	String	Whether the shutdown instances will be charged. Valid values: KEEP_CHARGING: keep charging after shutdown. STOP_CHARGING: stop charging after shutdown. Default value: KEEP_CHARGING.

3. Output Parameters

Parameter Name	Type	Description
ActivityId	String	The scaling activity ID.
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Shutting down instances in the scaling group in the manner of No Charges When Shut Down

Input Example

https://as.tencentcloudapi.com/?Action=StopAutoScalingInstances
&AutoScalingGroupId=asg-boz1qhnk
&InstanceIds.0=ins-cri8d02t
&InstanceIds.1=ins-osckfnm7
&StoppedMode=STOP_CHARGING
<Common request parameters>

Output Example

{
  "Response": {
    "ActivityId": "asa-m1ebiskl",
    "RequestId": "f3e2873c-af7c-43ee-8aa7-53565d4181c2"
  }
}

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

Tencent Cloud CLI 3.0

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
FailedOperation.NoActivityToGenerate	No scaling activity is generated.
InternalError.RequestError	An internal request error occurred.
InvalidParameterValue.InvalidAutoScalingGroupId	Invalid scaling group ID.
InvalidParameterValue.InvalidInstanceId	Invalid instance ID.
ResourceInsufficient.AutoScalingGroupBelowMinSize	The number of instances in the auto scaling group is below the minimum value.
ResourceInsufficient.InServiceInstanceBelowMinSize	The number of instances in a scaling group is less than the minimum capacity.
ResourceNotFound.AutoScalingGroupNotFound	The scaling group does not exist.
ResourceNotFound.InstancesNotInAutoScalingGroup	The target instance is not in the auto scaling group.
ResourceUnavailable.AutoScalingGroupInActivity	The auto scaling group is active.
ResourceUnavailable.InstanceInOperation	The specified instance is active.
ResourceUnavailable.InstanceNotSupportStopCharging	The instance does not support No Charges When Shut Down.
ResourceUnavailable.LoadBalancerInOperation	CLB is active in the scaling group.