- 文档首页
云服务器
云服务器ECS
API参考
实例
RebootInstances - 重启实例
RebootInstances - 重启实例
调用 RebootInstances 接口重启一台或多台实例。
使用说明
只有处于 运行中 状态的实例,才支持重启操作。
注意事项
- 使用本接口重启裸金属实例可能导致实例数据丢失,请通过云服务器控制台完成重启操作。
调试
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
请求参数
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。 Action string 必选 示例值:RebootInstances
要执行的操作,取值:RebootInstances。
Version string 必选 示例值:2020-04-01
API的版本,取值:2020-04-01。
ClientToken string 可选 示例值:333456899ff****
保证请求幂等性。由客户端自动生成一个参数值,确保不同请求间该参数值唯一,避免当调用API超时或服务器内部错误时,客户端多次重试导致重复性操作。
取值:仅支持ASCII字符,且不能超过64个字符。
ForceStop boolean 可选 示例值:false
重启实例前是否强制关机,取值:
- true:强制关机。相当于典型的断电操作,所有未写入存储设备的缓存数据会丢失。
说明
以下类型的实例,ForceStop无论取值为true还是false,实例均会执行强制关机。
- 高性能计算GPU型ebmhpcpni2l 、ebmhpcpni2、ebmhpchfpni2实例。
ebmhpcpni2l 、ebmhpcpni2、ebmhpchfpni2正在邀测中,如需试用,请联系客户经理申请。
InstanceIds.N string[] 必选 示例值:InstanceIds.1=i-ybo349sxoncm9t******&InstanceIds.2=i-ybo349sxolcm9t******
实例ID,最多支持100个ID。
返回参数
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。 说明
仅当请求参数输入不合法时提示下文中的接口错误码。若请求参数输入无误,将不会提示接口错误码,且接口的返回状态码将为200,但这并不代表对所有实例的操作均已成功,单个实例的操作结果请参见如下返回参数中的信息。 OperationDetails object[] 示例值:--
操作详情。
Error object 示例值:--
操作的实例错误信息。
Code string 示例值:InvalidInstance.NotFound
批量操作时具体单个请求失败的错误码。取值:
- InvalidInstance.NotFound:指定的实例不存在。
- MissingParameter.InstanceId:实例ID不能为空。
- InvalidInstanceStatus :当前实例的状态不支持此操作。
- OperationDenied.ResourceLocked:指定的操作被拒绝,因为您的资源已被其他操作锁定。
- OperationDenied.ResourceCreatedByOtherService:指定的操作被拒绝,因为您的资源被其他服务创建。您可以通过资源的系统标签查询对应服务。
- OperationDenied.InstanceIsCreatingImage:指定的操作被拒绝,因为您的实例正在创建自定义镜像。
- FlowLimitExceeded:您已超过资源请求限速。
- InternalError:内部错误,请重试。如果多次尝试失败,请提交工单。
- Insufficient.Balance:账户余额不足。
Message string 示例值:The specified instance does not exist.
批量操作时具体单个请求失败的错误信息。取值:
- The specified instance does not exist.
- The required parameter InstanceId is not supplied.
- The status of the specified instance does not support this request.
- The specified operation is denied as your resource is locked for another operation.
- 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 denied as your instance is creating image.
- You've reach the limit on request rate of resources.
- An internal error has occurred.
- The request is denied due to the lack of balance.
InstanceId string 示例值:i-ybo349sxoncm9t******
操作的实例ID。
请求示例
GET /?Action=RebootInstances&Version=2020-04-01&InstanceIds.1=i-ybo349sxoncm9t******&InstanceIds.2=i-ybo349sxolcm9t****** HTTP/1.1
Host: ecs.cn-beijing.volcengineapi.com
返回示例
"RequestId": "2021062415303301022514515207C4****",
"Action": "RebootInstances",
"Version": "2020-04-01",
"InstanceId": "i-ybo349sxoncm9t******",
"Code": "InvalidInstanceStatus",
"Message": "The status of the specified instance does not support this request."
"InstanceId": "i-ybo349sxolcm9t******",
"Code": "InvalidInstance.NotFound",
"Message": "The specified instance does not exist."
错误码
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
最近更新时间:2025.12.30 10:06:52