Domain name for API request: as.tencentcloudapi.com.
This API is used to shut down CVM instances in a scaling group.
SOFT_FIRST
shutdown, which means the CVM will be forcibly shut down if the soft shutdown fails.IN_SERVICE
status will reduce the desired capacity, but the desired capacity cannot be less than the minimum value.STOP_CHARGING
shutdown, the instances you want to shut down must satisfy the conditions of no charges when shut down.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: 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. |
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. |
https://as.tencentcloudapi.com/?Action=StopAutoScalingInstances
&AutoScalingGroupId=asg-boz1qhnk
&InstanceIds.0=ins-cri8d02t
&InstanceIds.1=ins-osckfnm7
&StoppedMode=STOP_CHARGING
&<Common Request Parameter>
{
"Response": {
"ActivityId": "asa-m1ebiskl",
"RequestId": "f3e2873c-af7c-43ee-8aa7-53565d4181c2"
}
}
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 |
---|---|
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.InstanceNotSupportStopCharging | The instance does not support No Charges When Shut Down. |
Was this page helpful?