RebootInstances - Elastic Compute Service - Alibaba Cloud Documentation Center

Restarts Elastic Compute Service (ECS) instances that are in the Running state. After you call this API operation, the instances enter the Stopping state and then the Running state.

Operation description

Usage notes

The ECS instances to be restarted must be in the Running (Running) state.
You can use BatchOptimization 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 starting the server. If data in the instance operating system is not written to block storage devices when the operation is called, the data is lost.
If the response contains {"OperationLocks": {"LockReason" : "security"}} when you query the information of the instance, the instance is locked for security reasons and all operations are prohibited on it.

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:RebootInstances	update	Instance acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}	none	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: true: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect 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 sends the request. If the request passes the dry run, the instance is restarted. 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: 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 is lost. false: normally restarts the instance. Default value: false.	false
BatchOptimization	string	No	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.	AllTogether
InstanceId	array	Yes	The instance IDs. You can specify up to 100 instance IDs.
	string	Yes	The instance ID.	i-bp67acfmxazb4p****

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
InstanceResponses	array<object>	Details about instance-specific responses, which contain the status of each instance before and after the operation is called and the results of the operation.
InstanceResponse	object
Code	string	The error code returned for the instance. A return value of 200 indicates that the operation is successful. For more information, see the "Error codes" section of this topic.	200
Message	string	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 of this topic.	success
InstanceId	string	The ID of the instance.	i-bp1g6zv0ce8oghu7****
CurrentStatus	string	The current state of the instance.	Stopping
PreviousStatus	string	The state of the instance before the operation is called.	Running

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

No change history