Restarts an Elastic Compute Service (ECS) instance that is in the Running state.
Operation description
- Only instances that are in the
Running
state can be restarted.**** - After an instance is restarted, the status of the instance changes to
Starting
.**** - An instance can be forcibly restarted. A forced restart (
ForceStop
) is equivalent to performing a hard restart. This operation can cause data loss if data in the instance is not written to the disk. - If you call the DescribeInstances operation to query the details of an instance and
OperationLocks
in the response contains "LockReason": "security", the instance is locked for security reasons and cannot be restarted. For more information, see API behavior when an instance is locked for security reasons.
Debugging
Authorization information
There is currently no authorization information disclosed in the API.
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
InstanceId | string | Yes | The instance ID. | i-bp67acfmxazb4ph**** |
ForceStop | boolean | No | Specifies whether to forcefully stop the instance before you restart the instance. Valid values:
| false |
DryRun | boolean | No | Specifies whether to perform only a dry run. Valid values:
Default value: false. | false |
Response parameters
Examples
Sample success responses
JSON
format
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
403 | IncorrectInstanceStatus | The current status of the resource does not support this operation. | The resource is in a state that does not support the current operation. |
403 | InstanceLockedForSecurity | The specified operation is denied as your instance is locked for security reasons. | - |
403 | DiskError | IncorrectDiskStatus. | The disk state is invalid. |
403 | InstanceExpiredOrInArrears | The specified operation is denied as your prepay instance is expired (prepay mode) or in arrears (afterpay mode). | The subscription instance has expired. You must renew the instance before you can proceed. |
403 | IncorrectInstanceStatus | %s | The instance is in a state that does not support the current operation. |
403 | InvalidParameter.KMSKeyId.CMKUnauthorized | %s | - |
403 | InvalidParameter.KMSKeyId.CMKNotEnabled | %s | - |
403 | InvalidParameter.KMSKeyId.KMSUnauthorized | %s | - |
404 | InvalidParameter.KMSKeyId.NotFound | %s | - |
404 | InvalidInstanceId.NotFound | The specified InstanceId does not exist. | The specified instance does not exist. |
500 | InternalError | The request processing has failed due to some unknown error. | An internal error has occurred. Try again later. |
500 | InternalError | The request processing has failed due to some unknown error, exception or failure. | An internal error has occurred. Try again later. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
2023-07-17 | The Error code has changed | see changesets | ||||||||
|