tencent cloud

Feedback

StopAutoScalingInstances

Last updated: 2022-08-17 15:34:12
## 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](https://www.tencentcloud.com/document/product/213/19918?from_cn_redirect=1). * 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.
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](https://www.tencentcloud.com/document/api/377/30987). | Parameter Name | Required | Type | Description | |---------|---------|---------|---------| | Action | Yes | String | [Common Params](https://www.tencentcloud.com/document/api/377/30987). The value used for this API: StopAutoScalingInstances. | | Version | Yes | String | [Common Params](https://www.tencentcloud.com/document/api/377/30987). The value used for this API: 2018-04-19. | | Region | Yes | String | [Common Params](https://www.tencentcloud.com/document/api/377/30987). For more information, please see the [list of regions](https://www.tencentcloud.com/document/api/377/30987#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8) 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 ``` POST / HTTP/1.1 Host: as.tencentcloudapi.com Content-Type: application/json X-TC-Action: StopAutoScalingInstances { "AutoScalingGroupId": "asg-boz1qhnk", "StoppedMode": "STOP_CHARGING", "InstanceIds": [ "ins-osckfnm7", "ins-cri8d02t" ] } ``` #### 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. * [Tencent Cloud SDK 3.0 for Python](https://github.com/TencentCloud/tencentcloud-sdk-python-intl-en/blob/master/tencentcloud/as/v20180419/as_client.py) * [Tencent Cloud SDK 3.0 for Java](https://github.com/TencentCloud/tencentcloud-sdk-java-intl-en/blob/master/src/main/java/com/tencentcloudapi/as/v20180419/AsClient.java) * [Tencent Cloud SDK 3.0 for PHP](https://github.com/TencentCloud/tencentcloud-sdk-php-intl-en/blob/master/src/TencentCloud/As/V20180419/AsClient.php) * [Tencent Cloud SDK 3.0 for Go](https://github.com/TencentCloud/tencentcloud-sdk-go-intl-en/blob/master/tencentcloud/as/v20180419/client.go) * [Tencent Cloud SDK 3.0 for NodeJS](https://github.com/TencentCloud/tencentcloud-sdk-nodejs-intl-en/blob/master/tencentcloud/services/as/v20180419/as_client.js) * [Tencent Cloud SDK 3.0 for .NET](https://github.com/TencentCloud/tencentcloud-sdk-dotnet-intl-en/blob/master/TencentCloud/As/V20180419/AsClient.cs) * [Tencent Cloud SDK 3.0 for C++](https://github.com/TencentCloud/tencentcloud-sdk-cpp-intl-en/blob/master/as/src/v20180419/AsClient.cpp) ### Command Line Interface * [Tencent Cloud CLI 3.0](https://www.tencentcloud.com/document/product/1013) ## 6. Error Code The following only lists the error codes related to the API business logic. For other error codes, see [Common Error Codes](https://www.tencentcloud.com/document/api/377/31019#.E5.85.AC.E5.85.B1.E9.94.99.E8.AF.AF.E7.A0.81). | Error Code | Description | |---------|---------| | CallCvmError | CVM API call failed. | | FailedOperation.NoActivityToGenerate | No scaling activity is generated. | | InternalError.CalleeError | Exceptions occurred while invoking other services. | | InternalError.RequestError | An internal request error occurred. | | InvalidParameter.ActionNotFound | Invalid Action request. | | 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. |
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