Domain name for API request: cvm.tencentcloudapi.com.
This API is used to shut down instances.
RUNNING.STOPPING when the API is called successfully and STOPPED when the instance is successfully shut down.A maximum of 10 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: cvm.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: StopInstances. |
| Version | Yes | String | Common parameter. The value used for this API: 2017-03-12. |
| Region | Yes | String | Common parameter. For more information, please see the list of regions supported by the product. |
| InstanceIds.N | Yes | Array of String | Instance ID(s). To obtain the instance IDs, you can call DescribeInstances and look for InstanceId in the response. The maximum number of instances in each request is 100. |
| ForceStop | No | Boolean | Whether to force shut down an instance after a normal shutdown fails. Valid values: Default value: FALSE. |
| StopType | No | String | Instance shutdown mode. Valid values: Default value: SOFT. |
| StoppedMode | No | String | Billing method of a pay-as-you-go instance after shutdown. Valid values: Default value: KEEP_CHARGING. This parameter is only valid for some pay-as-you-go instances using cloud disks. For more information, see No charges when shut down for pay-as-you-go instances. |
| Parameter Name | Type | Description |
|---|---|---|
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
This example shows you how to shut down two instances.
GET https://cvm.tencentcloudapi.com/?Action=StopInstances
&InstanceIds.0=ins-r8hr2upy
&InstanceIds.1=ins-5d8a23rs
&ForceStop=FALSE
&<Common request parameters>{
"Response": {
"RequestId": "6ef60bec-0242-43af-bb20-270359fb54a7"
}
}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 |
|---|---|
| InternalServerError | Internal error. |
| InvalidInstance.NotSupported | This instance is not supported. |
| InvalidInstanceId.Malformed | Invalid instance ID. The specified instance ID has an invalid format. For example, ins-1122 has an invalid ID length. |
| InvalidInstanceId.NotFound | No instance found. |
| InvalidParameterCombination | The parameter combination is invalid. |
| InvalidParameterValue | Incorrect parameter value. |
| InvalidParameterValue.LimitExceeded | The number of parameter values exceeds the limit. |
| MissingParameter | Missing parameter. |
| MutexOperation.TaskRunning | An identical job is running. |
| OperationDenied.InstanceOperationInProgress | The instance has an operation in progress. Please try again later. |
| UnauthorizedOperation.MFAExpired | Unauthorized operation. Make sure Multi-Factor Authentication (MFA) is valid. |
| UnauthorizedOperation.MFANotFound | Unauthorized operation. Make sure Multi-Factor Authentication (MFA) exists. |
| UnsupportedOperation.InstanceStatePending | The instances are being created, and this operation is not supported. |
| UnsupportedOperation.InstanceStateRebooting | The instances are being restarted, and this operation is not supported. |
| UnsupportedOperation.InstanceStateRescueMode | Instances in the rescue mode are not available for this operation. |
| UnsupportedOperation.InstanceStateServiceLiveMigrate | The instances are being migrated, and this operation is not supported. |
| UnsupportedOperation.InstanceStateShutdown | Isolated instances do not support this operation. |
| UnsupportedOperation.InstanceStateStopped | The instance has been shut down, and this operation is not supported. |
| UnsupportedOperation.InstanceStateStopping | The instance is being shut down, and this operation is not supported. |
| UnsupportedOperation.InstanceStateTerminating | The instance is being terminated, and the operation is not supported. |
| UnsupportedOperation.StoppedModeStopCharging | The instance does not support the no charges when shut down feature. |
Was this page helpful?