All Products
Document Center

Elastic Compute Service:RebootInstances

Last Updated:Apr 11, 2024

Restarts Elastic Compute Service (ECS) instances. After this API operation is called, the ECS instances enter the Stopping state and then the Running state.

Operation description

  • The ECS instances must be in the Running state.****
  • You can use the BatchOptimization parameter to specify the batch operation mode and restart multiple instances at a time.
  • Instances can be forcefully restarted. A forced restart (ForceReboot) is equivalent to powering off a traditional server and then restarting the server. If data in the instance operating system is not written to block storage devices when the operation is called, the data may be lost.
  • If OperationLocks in the response of the DescribeInstances operation contains "LockReason" : "security" for an instance, the instance is locked for security reasons and all operations are prohibited on it.


OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters


Specifies whether to perform only a dry run, without performing the actual request. Valid values:

  • true: performs only a dry run. The system checks the required parameters, request syntax, and instance status. If the request fails the dry run, an error message is returned. If the request passes the dry run, DRYRUN.SUCCESS is returned.
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.
  • false: performs a dry run and performs the actual request.

Default value: false.


The region ID. You can call the DescribeRegions operation to query the most recent region list.


Specifies whether to forcefully restart the instance. Valid values:

  • true: forcefully restarts the instance. This operation is equivalent to the typical power-off operation. Cache data that is not written to storage devices on the instance will be lost.
  • false: normally restarts the instance.

Default value: false.


The batch operation mode. Valid values:

  • AllTogether: In this mode, if all instances are restarted, a success message is returned. If an instance fails the verification, all instances fail to be restarted, and an error message is returned.
  • SuccessFirst: In this mode, each instance is restarted separately. The response contains the operation results of each instance.

Default value: AllTogether.


The instance IDs. You can specify up to 100 instance IDs.


The instance ID.


Response parameters


The request ID.

InstanceResponsesobject []

Details about the responses returned for the instances, which contain the status of each instance before and after the operation is called and the operation results.


The error code that is returned for the operation on the instance. The value 200 indicates that the operation is successful. For more information, see the "Error codes" section in this topic.


The error message that is returned for the operation on the instance. The return value Success indicates that the operation is successful. For more information, see the "Error codes" section in this topic.


The instance ID.


The current status of the instance.


The status of the instance before the operation is called.



Sample success responses


  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "InstanceResponses": {
    "InstanceResponse": [
        "Code": "200",
        "Message": "success",
        "InstanceId": "i-bp1g6zv0ce8oghu7****",
        "CurrentStatus": "Stopping",
        "PreviousStatus": "Running"

Error codes

HTTP status codeError codeError messageDescription
400InvalidParameter.KMSKeyId.CMKNotEnabledThe CMK needs to be added ECS tag-
400InvalidParameter.KMSKeyId.CMKNotEnabledThe 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.
400InvalidParameter.KMSKeyId.KMSUnauthorizedECS service account have no right to access your KMS.-
400DRYRUN.SUCCESSThis request is a dryrun request with successful result.The request is checked and determined as valid.
403InvalidInstanceId.NotFoundInstanceId should not be null.-
403InvalidParameter.TooManyInstanceIdsInstance ids cannot be more than 100.-
403Abs.InvalidInstanceIds.MalFormedThe specified instanceIds is not valid.-
403IncorrectInstanceStatus%sThe instance is in a state that does not support the current operation.
403InsufficientBalanceYour account does not have enough balance.Your account balance is insufficient. Add funds to your account and try again.
403InstanceNotReadyThe 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.
404InvalidInstanceId.NotFound%sThe specified instance does not exist. Check whether the InstanceId parameter is valid.
404InvalidInstanceIds.NotFoundThe 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.
404InvalidInstanceId.NotFoundThe specified InstanceId does not exist.The specified instance does not exist.
409InvalidOperation.ConflictRequest was denied due to conflict with a previous request, please try again later.-
500InternalErrorThe 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.