1. 接口描述
接口请求域名： cvm.tencentcloudapi.com 。
进入救援模式
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：EnterRescueMode。 |
| Version | 是 | String | 公共参数，本接口取值：2017-03-12。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 需要进入救援模式的实例id 示例值：'ins-abcdefg' |
| Password | 是 | String | 救援模式下系统密码 示例值：'hello123456789' |
| Username | 否 | String | 救援模式下系统用户名 示例值：'root' |
| StopType | 否 | String | 实例的关闭模式。取值范围： 默认取值：SOFT。 示例值：HARD |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 进入救援模式
输入示例
POST / HTTP/1.1
Host: cvm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: EnterRescueMode
<公共请求参数>
{
"InstanceId": "instance_Id",
"Password": "\"uu7797UUX\""
}输出示例
{
"Response": {
"RequestId": "5920380e-277a-420a-a221-0caac3eb7159"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidInstance.NotSupported | 不被支持的实例。 |
| InvalidInstanceId.Malformed | 无效实例ID。指定的实例ID格式错误。例如实例ID长度错误ins-1122。 |
| InvalidInstanceId.NotFound | 没有找到相应实例。 |
| InvalidParameterValue.InstanceIdMalformed | 实例ID不合要求，请提供规范的实例ID，类似ins-xxxxxxxx，字母x代表小写字符或数字。 |
| InvalidParameterValue.InvalidPassword | 无效密码。指定的密码不符合密码复杂度限制。例如密码长度不符合限制等。 |
| InvalidPassword | 无效密码。指定的密码不符合密码复杂度限制。例如密码长度不符合限制等。 |
| MutexOperation.TaskRunning | 同样的任务正在运行。 |
| OperationDenied.InstanceOperationInProgress | 实例正在执行其他操作，请稍后再试。 |
| UnsupportedOperation.ArmArchitecture | 该操作暂不支持Arm机器。 |
| UnsupportedOperation.EdgeZoneNotSupportCloudDisk | 所选择的边缘可用区不支持云盘操作。 |
| UnsupportedOperation.InstanceReinstallFailed | 当前实例为重装系统失败状态，不支持此操作；推荐您再次重装系统，也可以销毁/退还实例或提交工单 |
| UnsupportedOperation.InstanceStateBanning | 该子机处于封禁状态，请联系相关人员处理。 |
| UnsupportedOperation.InstanceStateEnterRescueMode | 请求不支持进入救援模式的实例 |
| UnsupportedOperation.InstanceStateEnterServiceLiveMigrate | 不支持状态为 ENTER_SERVICE_LIVE_MIGRATE.的实例 ins-xxxxxx 。 |
| UnsupportedOperation.InstanceStateExitRescueMode | 请求不支持正在退出救援模式的实例 |
| UnsupportedOperation.InstanceStateExitServiceLiveMigrate | 不支持状态为 EXIT_SERVICE_LIVE_MIGRATE.的实例 ins-xxxxxx 。 |
| UnsupportedOperation.InstanceStateFreezing | 操作不支持已冻结的实例。 |
| UnsupportedOperation.InstanceStateRebooting | 请求不支持正在重启的实例 |
| UnsupportedOperation.InstanceStateRescueMode | 请求不支持救援模式的实例 |
| UnsupportedOperation.InstanceStateServiceLiveMigrate | 不支持正在服务迁移的实例，请稍后再试 |
| UnsupportedOperation.InstanceStateShutdown | 请求不支持隔离状态的实例 |
| UnsupportedOperation.InstanceStateStopping | 请求不支持正在关机的实例 |
| UnsupportedOperation.InstanceStateTerminating | 请求不支持正在销毁的实例 |
| UnsupportedOperation.SpecialInstanceType | 请求不支持特殊机型的实例 |
| UnsupportedOperation.StoppedModeStopCharging | 不支持关机不收费特性 |
