RebootInstance - Elastic Compute Service - Alibaba Cloud Documentation Center

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

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

Debug

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	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 instance before you restart the instance. Valid values: true: stops the instance in a forceful manner. This operation is equivalent to the power-off operation. Cache data that is not written to storage devices on the instance is lost. false (default): normally stops the instance.	false
DryRun	boolean	No	Specifies whether to perform only a dry run. Valid values: true: performs only a dry run. The system checks the required parameters, the request format, service limits, and available ECS resources. If the request fails the dry run, the corresponding error message is returned. If the request passes the dry run, the `DryRunOperation` error code is returned. false: performs a dry run and sends the request. If the request passes the dry run, the instance is restarted. Default value: false.	false

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Examples

Sample success responses

JSONformat

{
  "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