RebootInstances - 批量重启实例 - 云服务器 ECS

本接口用于重启一台或多台ECS实例，支持您通过参数来选择是否强制重启和设置不同的批量操作模式。

接口说明

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

使用须知

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

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
ecs:RebootInstances	update	*Instance `acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}`	无	无

请求参数

名称	类型	必填	描述	示例值
DryRun	boolean	否	是否只预检此次请求。取值范围： true：发送检查请求，不会重启实例。检查项包括是否填写了必需参数、请求格式、实例状态。如果检查不通过，则返回对应错误。如果检查通过，则返回`DRYRUN.SUCCESS`。说明如果参数`BatchOptimization`被设置为`SuccessFirst`，对应的`DryRun=true`的预检结果只会返回`DRYRUN.SUCCESS`。 false：发送正常请求，通过检查后直接重启实例。默认值：false。	false
RegionId	string	是	实例所在的地域。您可以调用 DescribeRegions 查看最新的阿里云地域列表。	cn-hangzhou
ForceReboot	boolean	否	是否强制重启。取值范围： true：强制重启。相当于典型的断电操作，所有未写入存储设备的缓存数据会丢失。 false：正常重启。默认值：false。	false
BatchOptimization	string	否	设置批量操作模式。取值范围： AllTogether：该模式下，如果实例全部重启成功，则返回成功信息；如果任意一个实例校验不通过，则所有实例重启失败，并返回失败信息。 SuccessFirst：该模式下，分别重启每个实例，返回结果包含每个实例的操作结果信息。默认值：AllTogether。	AllTogether
InstanceId	array	是	实例 ID 数组。数组长度：1~100。
	string	是	实例 ID。	i-bp67acfmxazb4p****

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
InstanceResponses	array<object>	由 InstanceResponse 组成的数组格式，返回每个实例操作的前后状态及操作结果。
InstanceResponse	object
Code	string	实例操作结果错误码。返回值为 200 表示操作成功。更多信息，请参见下文错误码列表。	200
Message	string	实例操作返回错误信息。返回值为 Success 表示操作成功。更多信息，请参见下文错误码列表。	success
InstanceId	string	实例 ID。	i-bp1g6zv0ce8oghu7****
CurrentStatus	string	实例当前状态。	Stopping
PreviousStatus	string	实例操作前状态。	Running

示例

正常返回示例

JSON格式

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

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParameter.KMSKeyId.CMKNotEnabled	The CMK needs to be added ECS tag	-
400	InvalidParameter.KMSKeyId.CMKNotEnabled	The CMK needs to be enabled.	加密云盘设置了 KMSKeyId 后，CMK必须处于启用状态。您可以调用密钥管理服务的 DescribeKey 接口查询指定CMK的相关信息。
400	InvalidParameter.KMSKeyId.KMSUnauthorized	ECS service account have no right to access your KMS.	ECS 服务无权访问您的 KMS
400	DRYRUN.SUCCESS	This request is a dryrun request with successful result.	您设置了预检此次请求，并且检查通过。
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.	指定的InstanceId参数不合法
403	InstanceLockedForSecurity	%s	-
403	InstanceExpiredOrInArrears	%s	-
403	IncorrectInstanceStatus	%s	当前实例的状态不支持此操作。
403	InvalidInstance.NotFoundSystemDisk	%s	指定的实例ID未挂载系统盘，无法启动，具体信息请参见错误信息%s占位符的实际返回结果。请先调用AttachDisk为指定的实例挂载系统盘。
403	InsufficientBalance	Your account does not have enough balance.	账户余额不足，请先充值再操作。
403	InstanceNotReady	The specified instance is not ready for use.	该资源目前的状态不支持此操作，请您等待一段时间再进行操作，并确认实例目前状态与操作是否冲突。
404	InvalidInstanceId.NotFound	%s	指定的实例不存在，请确认参数 InstanceId 是否正确。
404	InvalidInstanceIds.NotFound	The specified InstanceIds does not exist.	指定的 InstanceId 不存在。请检查 InstanceId 参数值是否正确。您可以调用 DescribeInstances 查询指定实例的状态。
404	InvalidInstanceId.NotFound	The specified InstanceId does not exist.	指定的InstanceId不存在。
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.	内部错误，请重试。

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作

暂无变更历史