Use RebootInstances to restart ECS instances - Elastic Compute Service - Alibaba Cloud - Elastic Compute Service

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

该接口为异步接口，实例的重启不是立即完成的，成功调用后，实例会先进入启动中（Starting）状态，你可以调用 DescribeInstanceStatus 查看实例状态，当返回的状态为Running时代表重启成功。

使用须知

被安全锁定的实例不能通过调用该接口重启。更多信息，请参见资源安全锁定对调用 API 的影响。
ECS 实例的状态必须为运行中（Running）。

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

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: 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 IDs of ECS instances. Valid values of N: 1 to 100.	i-bp67acfmxazb4p****
	string	No	The ID of ECS instance N.	i-bp67acfmxazb4p****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
InstanceResponses	object
InstanceResponse	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.
	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

Success response

JSON format

{
  "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.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.
500	InternalError	The request processing has failed due to some unknown error.
403	InvalidInstanceId.NotFound	InstanceId should not be null.
403	InvalidParameter.TooManyInstanceIds	Instance ids cannot be more than 100.	InstanceIds 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.
403	InstanceNotReady	The specified instance is not ready for use.
404	InvalidInstanceId.NotFound	%s
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.
503	LimitedOperation.ServiceUnavailable	The service is currently unavailable. Please try again later.	The service is currently unavailable. Please try again later.
409	InvalidOperation.Conflict	Request was denied due to conflict with a previous request, please try again later.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.