Stop an Instance
Last Updated：2020-07-20
Stops the specified instance.
- The system backend is in the Stopped status after the instance is stopped successfully.
- This operation can be performed only when the instance is in the Running status. Otherwise, it prompts an error 409.
- You can forcibly stop an instance, which is equivalent to the power failure and may lose the data that is not written to the disk in the instance operating system.
Request Structure
PUT /v{version}/instance/{instanceId}?{action} HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: authorization string
{
"forceStop":forceStop
}Request Header Field
There are no other special header fields except the public header field.
Request Parameters
| Parameter Name | Type | Required | Parameter Position | Description |
|---|---|---|---|---|
| version | String | Yes | URL parameter | API version number |
| instanceId | String | Yes | URL parameter | Instance ID to start |
| action | String | Yes | Query Parameter | Action on instance. This parameter value is Stop in this interface. |
| forceStop | Boolean | No | Request Body Parameter | It specifies whether the instance is forcibly stopped. Optional value: true and false, false by default. |
Return Header Field
Other special header fields are not available, except for common header fields.
Return a parameter
No specific parameters are returned.
Error Code
| Error Code | Error Description | HTTP Status Code | Explanations |
|---|---|---|---|
| Instance.StopInstanceOperationForbidden | Instance not running when shutting down | 409 | The instance can be stopped only when it is in the Running status. |
Request Instance
PUT /v2/instance/i-YufwpQAe?stop HTTP/1.1
Host: bcc.bj.baidubce.com
ContentType: application/json
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
{
"forceStop":false
}Return Instance
HTTP/1.1 200 OK
x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
Date: Wed, 03 Dec 2014 06:42:19 GMT
Content-Type: application/json;charset=UTF-8
Server: BWS