Restarts an Elastic Compute Service (ECS) instance.
Operation description
This operation is an asynchronous operation. After you call this operation to restart an ECS instance, the operation sets the status of the ECS instance to Starting
and begins the restart process. You can call the DescribeInstanceStatus operation to query the status of the ECS instance. When the status of the ECS instance changes to Running
, the instance is restarted.
-
Notes
- You cannot call this operation to restart an ECS instance that is locked for security reasons. For more information, see API behavior when an instance is locked for security reasons.
- The ECS instance that you want to restart must be in the Running (
Running
) state.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action
policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resources
is used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
ecs:RebootInstance | update | *Instance acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId} |
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
InstanceId | string | Yes | The instance ID. | i-bp67acfmxazb4ph**** |
ForceStop | boolean | No | Specifies whether to forcefully stop the ECS instance before the instance is restarted. Valid values:
Default value: false. | false |
DryRun | boolean | No | Specifies whether to perform only a dry run, without performing the actual request. 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 | View Change Details |