Stop an instance
Updated at：2025-10-20
This API is used to stop specified instances.
- The system will update the status to "Stopped" after the instance has been successfully stopped.
- This operation is only permitted for instances with a Running status; otherwise, a 409 error will be returned.
- The instance supports forced stopping, similar to a power-off operation, which might lead to the loss of data that hasn't been saved to the disk in the instance's OS.
Request structure
Plain Text
1PUT /v{version}/instance/{instanceId}?{action} HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: authorization string
4{
5 "forceStop":forceStop,
6 "stopWithNoCharge":stopWithNoCharge
7}Request headers
There are no special headers required beyond the common headers.
Request parameters
| Parameter name | Types | Whether required | Parameter location | Description |
|---|---|---|---|---|
| version | String | Yes | URL parameter | API version number |
| instanceId | String | Yes | URL parameter | Instance ID to be started |
| action | String | Yes | Query | Action performed on the instance. In this API, the value of this parameter is stop |
| forceStop | Boolean | No | RequestBody | Specify whether to forcibly stop the instance. Options: true, false. The default is false |
| stopWithNoCharge | Boolean | No | RequestBody | Specify whether to perform no charge for stopped instances. Optional values: true, false. The default is false. |
Response headers
No special headers are required beyond the standard ones.
Response parameters
No special response parameters are available.
Error codes
| Error code | Error description | HTTP status code | Chinese explanation |
|---|---|---|---|
| Instance.StopInstanceOperationForbidden | Instance not running when shutting down | 409 | Only instances in the Running status can be stopped |
| Bcc.PrePayCannotStopWithNoCharge | pre pay instance can not stop with no charge. | 403 | No charge for stopped instances is not supported for prepaid instances |
| Bcc.Rocv1CannotStopWithNoCharge | Shutdown no charge feature is not available for instances with local disk. | 403 | The feature of no charge for stopped instances does not apply to instances with local disks |
| Bcc.InstanceTypeNotSupportException | Shutdown no charge feature is not available for this type of instance. | 403 | The feature of no charge for stopped instances does not apply to this type of instance |
| Bcc.InstanceTypeNotSupportException | The instance is in the state of shutdown and no charge. This operation is not supported.If you need to do this, please cancel the shutdown and not charge. | 403 | The instance is already in the status of no charge for stopped instances and does not support this operation. Please cancel no charge for stopped instances first to perform this operation |
Request example
Plain Text
1PUT /v2/instance/i-YufwpQAe?stop HTTP/1.1
2Host: bcc.bj.baidubce.com
3ContentType: application/json
4Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
5
6{
7 "forceStop":false,
8 "stopWithNoCharge":true
9}Response example
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Wed, 03 Dec 2014 06:42:19 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS