Restarts Elastic Compute Service (ECS) instances. When you call this operation, you can configure parameters to specify a batch operation mode and whether to forcefully restart the instances.
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 instance. When the status of the ECS instance changes to Running, the instance is restarted.
-
Precautions
- You cannot call this operation to restart ECS instances that are locked due to security reasons. For more information, see API behavior when an instance is locked for security reasons.
- The ECS instances 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 Resourcesis 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:RebootInstances | update | *Instance acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| DryRun | boolean | No | Specifies whether to perform only a dry run, without performing the actual request. Valid values:
Note
If you set BatchOptimization to SuccessFirst and DryRun to true, only DRYRUN.SUCCESS is returned regardless of whether the request passes the dry run.
Default value: false. | false |
| RegionId | string | Yes | The region ID. You can call the DescribeRegions operation to query the most recent region list. | cn-hangzhou |
| ForceReboot | boolean | No | Specifies whether to forcefully restart the instance. Valid values:
Default value: false. | false |
| BatchOptimization | string | No | The batch operation mode. Valid values:
Default value: AllTogether. | AllTogether |
| InstanceId | array | Yes | The IDs of ECS instances. Valid values of N: 1 to 100. | |
| string | Yes | The ID of ECS instance N. | i-bp67acfmxazb4p**** |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"InstanceResponses": {
"InstanceResponse": [
{
"Code": "200",
"Message": "success",
"InstanceId": "i-bp1g6zv0ce8oghu7****",
"CurrentStatus": "Stopping",
"PreviousStatus": "Running"
}
]
}
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | InvalidParameter.KMSKeyId.CMKNotEnabled | The CMK needs to be added ECS tag | - |
| 400 | InvalidParameter.KMSKeyId.CMKNotEnabled | The CMK needs to be enabled. | The customer master key (CMK) is not enabled when KMSKeyId is specified for an encrypted disk. You can call the DescribeKey operation of KMS to query information about the specified CMK. |
| 400 | InvalidParameter.KMSKeyId.KMSUnauthorized | ECS service account have no right to access your KMS. | - |
| 400 | DRYRUN.SUCCESS | This request is a dryrun request with successful result. | The request is checked and determined as valid. |
| 403 | InvalidInstanceId.NotFound | InstanceId should not be null. | - |
| 403 | InvalidParameter.TooManyInstanceIds | Instance ids cannot be more than 100. | - |
| 403 | Abs.InvalidInstanceIds.MalFormed | The specified instanceIds is not valid. | - |
| 403 | InstanceLockedForSecurity | %s | - |
| 403 | InstanceExpiredOrInArrears | %s | - |
| 403 | IncorrectInstanceStatus | %s | The instance is in a state that does not support the current operation. |
| 403 | InvalidInstance.NotFoundSystemDisk | %s | - |
| 403 | InsufficientBalance | Your account does not have enough balance. | Your account balance is insufficient. Add funds to your account and try again. |
| 403 | InstanceNotReady | The specified instance is not ready for use. | The resource is in a state that does not support the current operation. Try again later and check whether the instance state supports the operation. |
| 404 | InvalidInstanceId.NotFound | %s | The specified instance does not exist. Check whether the InstanceId parameter is valid. |
| 404 | InvalidInstanceIds.NotFound | The specified InstanceIds does not exist. | The specified InstanceId parameter does not exist. You can call the DescribeInstances operation to query the state of the instance. |
| 404 | InvalidInstanceId.NotFound | The specified InstanceId does not exist. | The specified instance does not exist. |
| 409 | InvalidOperation.Conflict | Request was denied due to conflict with a previous request, please try again later. | - |
| 500 | InternalError | The request processing has failed due to some unknown error. | 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 |
|---|