Call the RebootInstance operation to restart an instance.

Usage notes

Only ECS instances in the Running state can be restarted.

Precautions

Restarting a bare metal instance using this operation may result in instance data loss. Complete the restart operation in the ECS console.

Restarting an instance will interrupt your business for a short period of time. Proceed with caution.

Debugging

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

Only the request parameters specific to this operation and some common parameters are listed below. For details, refer to Common parameters.

Action string required Sample value: RebootInstance

The operation that you want to perform. Value: RebootInstance.

Version string required Sample value: 2020-04-01

The API version. Valid value: 2020-04-01.

ClientToken string Optional Sample value: 333456899ff****

The ClientToken is used to ensure the request idempotency. You can use the client to automatically generate a token, but you must make sure that the token is unique among different requests. This prevents repeated actions due to multiple client retries when the call of the API action times out or an internal server error occurs.

Value: Only ASCII characters are supported. The length is no more than 64 ASCII characters.

DryRun boolean Optional Sample value: false

Specifies whether to only precheck this request.

true: Sends a check request without restarting the instance. Check items include whether the required parameters are provided, the request format, and business limits. If the check fails, the corresponding error is returned. If the check passes, the error code DryRunOperation is returned.

false (default): Sends a normal request and directly restarts the instance after the check is passed.

ForceStop boolean Optional Sample value: false

Whether to forcibly shut down the instance before restarting the instance. Valid values:

true: Forcibly shuts down the instance. It is equivalent to a typical power-off operation, and all cached data that has not been written to the storage device will be lost.

false (default): Normal shutdown.

tip

For the following types of instances, regardless of whether ForceStop is set to true or false, the instances will be forcibly shut down.

EBM instances.

HPC-optimized ebmhpcpni2l, ebmhpcpni2, and ebmhpchfpni2 instances.

ebmhpcpni2l, ebmhpcpni2, and ebmhpchfpni2 instances are currently in Beta. If you need a trial, please contact your account manager.

InstanceId string required Sample value: i-3tiefmkskq3vj0x0****

The instance ID.

Response parameters

This operation has no specific response parameters. For more information, refer to Response structure.

Sample request

Sample response

Error codes

The table below lists the business-related error codes of the operation. For more information, refer to Common error codes.

Status code	Error code	Error message	Description
400	IdempotentParameterMismatch	The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.	The idempotent parameters are inconsistent.
400	Insufficient.Balance	The request is denied due to the lack of balance.	The account balance is insufficient.
400	InvalidArgument	The specified argument is invalid.	The specified parameter is invalid.
400	InvalidClientToken.Malformed	The specified ClientToken is malformed.	The specified ClientToken is invalid.
400	InvalidDedicatedHostStatus.Unsupported	The status of the specified dedicated host does not support this request.	The dedicated host in current status does not support this action.
400	InvalidInstanceStatus	The status of the specified instance does not support this request.	The current status of the instance does not support this operation.
400	MissingParameter.InstanceId	The required parameter InstanceId is not supplied.	The parameter InstanceId cannot be left empty.
403	InvalidInstance.RequestForbidden	Request is forbidden by the server.	The specified resource can no longer be used because your account has violated relevant rules. To restore service availability, submit a ticket to our service team for assistance.
404	InvalidInstance.NotFound	The specified instance does not exist.	The specified instance does not exist.
412	DryRunOperation	Your request has been validated by the DryRunOperation.	Your request has been validated by "DryRun".
412	IdempotentProcessing	The request uses the same client token as a previous one that is still in process.	The previous idempotent request is still in process. Please try again later.
412	OperationDenied.InstanceIsCreatingImage	The specified operation is denied as your instance is creating image.	The specified operation is rejected because the instance is being used to create a custom image.
412	OperationDenied.ResourceCreatedByOtherService	The specified operation is denied as your resource is created by other service. You can check system tags to find the service.	The specified operation is rejected because your resource was created by another service. You can query the corresponding service based on the system tag of the resource.
412	OperationDenied.ResourceLocked	The specified operation is denied as your resource is locked for another operation.	The specified operation is rejected because your resource has been locked by another operation.
500	InternalError	An internal error has occurred.	An internal error occurred. Try again. If multiple attempts fail, submit a ticket.

Elastic Compute Service