Restart an Instance
Last Updated：2020-07-20
Restart the specified instance.
- This operation can be performed only when the instance is in the Running status. Otherwise, it prompts an error 409.
- After the API is called successfully, the instance is in the Starting status.
- You can forcibly restart an instance, which is equivalent to the power failure restart of the traditional compute 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 reboot in this interface. |
| forceStop | boolean | No | Request Body Parameter | Whether the instance is forcibly stopped? The optional value is true or false, false by default. |
Return Header Field
There are no other special header fields except the common header field.
Return Parameter
No specific parameters are returned.
Error Code
| Error Code | Error Description | HTTP Status Code | Explanations |
|---|---|---|---|
| Instance.RebootInstanceOperationForbidden | Instance not running when rebooting. | 409 | The instance can be restarted only when it is in the Running status. |
Request Instance
PUT /v2/instance/i-YufwpQAe?reboot HTTP/1.1
Host: bcc.bj.baidubce.com
ContentType: application/json
Date: Wed, 01 Mar 2006 12:00:00 GMT
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
{
"forceStop": true
}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