1. 接口描述
接口请求域名： ecm.tencentcloudapi.com 。
只有状态为RUNNING的实例才可以进行此操作；接口调用成功时，实例会进入REBOOTING状态；重启实例成功时，实例会进入RUNNING状态；支持强制重启，强制重启的效果等同于关闭物理计算机的电源开关再重新启动。强制重启可能会导致数据丢失或文件系统损坏，请仅在服务器不能正常重启时使用。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：RebootInstances。 |
| Version | 是 | String | 公共参数，本接口取值：2019-07-19。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| InstanceIdSet.N | 是 | Array of String | 待重启的实例ID列表。在单次请求的过程中，单个region下的请求实例数上限为100。 |
| ForceReboot | 否 | Boolean | 是否在正常重启失败后选择强制重启实例。取值范围： TRUE：表示在正常重启失败后进行强制重启； FALSE：表示在正常重启失败后不进行强制重启； 默认取值：FALSE。 |
| StopType | 否 | String | 关机类型。取值范围： SOFT：表示软关机 HARD：表示硬关机 SOFT_FIRST：表示优先软关机，失败再执行硬关机 默认取值：SOFT。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 实例重启
实例重启
输入示例
https://ecm.tencentcloudapi.com/?Action=RebootInstances
&InstanceIdSet.0=ein-496721al
&InstanceIdSet.1=ein-438242bp
&<公共请求参数>输出示例
{
"Response": {
"RequestId": "d40cdb72-7bc0-4b48-b3aa-djl3424-a6482"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.InternalOperationFailure | 内部操作错误。 |
| FailedOperation.OperationNotAllow | 不允许执行当前操作。 |
| InvalidParameter.InvalidDataFormat | 数据格式不正确。 |
| InvalidParameterValue.InvalidDataDiskType | 数据盘类型不合法。 |
| InvalidParameterValue.InvalidISPInNode | 运营商不合法。 |
| InvalidParameterValue.InvalidInstanceID | 实例ID不合法。 |
| InvalidParameterValue.ParameterValueTooLarge | 参数值超出限制。 |
| OperationDenied.InstanceOperationInProgress | 不允许执行当前操作。 |
| ResourceNotFound.InstanceNotExist | 实例不合法。 |
| ResourceUnavailable.InstanceNotRunning | 实例未运行。 |
| UnauthorizedOperation.ForbiddenOperation | 没有权限进行该操作。 |
