tencent cloud

云服务器

动态与公告
产品动态
公共镜像更新动态
操作系统官方停止维护计划
产品公告
产品简介
云服务器概述
产品优势
基本概念
地域和可用区
新手指引
Service Regions and Service Providers
产品计费
计费概述
计费方式
计费项
转换计费方式
购买实例
变配费用说明
欠费说明
快速入门
通过自定义配置购买 Linux 云服务器
通过自定义配置购买 Windows 云服务器
用户指南
操作指南总览
使用限制总览
实例
竞价实例
预留实例
镜像
存储
备份与恢复
网络
安全
密码/密钥
监控与告警
运维管理
便捷功能
迁移服务器
在线迁移
迁移咨询
故障处理
无法登录云服务器问题处理思路
Windows 实例登录相关故障
Linux 实例登录相关故障
其他实例登录相关故障
实例运行故障
Linux 实例内存故障
网络故障
实践教程
云服务器选型建议
搭建环境
搭建网站
搭建应用
搭建可视化界面
本地文件上传到云服务器
网络性能测试
其他实践教程
API 文档
History
Introduction
API Category
Making API Requests
Region APIs
Instance APIs
Cloud Hosting Cluster APIs
Image APIs
Instance Launch Template APIs
Placement Group APIs
Key APIs
Security Group APIs
Network APIs
Data Types
Error Codes
安全与合规
访问管理
网络
常见问题
地域和可用区相关
计费相关
实例相关
存储相关
镜像相关
服务器迁移相关
网络相关
安全相关
操作系统相关
运维和监控相关
访问管理相关
NTP 服务相关
应用场景相关
服务协议
CVM Service Level Agreements
Red Hat Enterprise Linux 镜像服务协议
Public IP Service Level Agreement
词汇表

EnterRescueMode

PDF
聚焦模式
字号
最后更新时间: 2026-03-26 22:24:40

1. API Description

Domain name for API request: cvm.intl.tencentcloudapi.com.

This API is used to enter the rescue mode.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: EnterRescueMode.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region Yes String Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo.
InstanceId Yes String Instance ID Needs to Enter Rescue Mode
Password Yes String System Password in Rescue Mode
Username No String System Username in Rescue Mode
StopType No String The shutdown mode of the instance. Valid values:
  • SOFT_FIRST: Indicates a forced shutdown after a graceful shutdown fails

  • HARD: Direct forced shutdown

  • SOFT: Soft shutdown only

  • Default value: SOFT.

    3. Output Parameters

    Parameter Name Type Description
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Entering the Rescue Mode

    Input Example

    POST / HTTP/1.1
    Host: cvm.intl.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: EnterRescueMode
    <Common request parameters>
    
    {
        "InstanceId": "ins-axzc12s",
        "Password": "Qcloud@TestApi123++"
    }
    

    Output Example

    {
        "Response": {
            "RequestId": "5920380e-277a-420a-a221-0caac3eb7159"
        }
    }
    

    5. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    InvalidInstance.NotSupported This instance is not supported.
    InvalidInstanceId.Malformed Invalid instance ID. The specified instance ID has an invalid format. For example, ins-1122 has an invalid ID length.
    InvalidInstanceId.NotFound No instance found.
    InvalidParameterValue.InstanceIdMalformed Invalid instance ID. Please enter a valid ID, such as ins-xxxxxxxx (“x” represents a lower-case letter or a number).
    InvalidParameterValue.InvalidPassword Invalid password. The specified password does not meet the complexity requirements (e.g., too long or too short)
    InvalidPassword Invalid password. The specified password does not meet the password requirements. For example, the password length does not meet the requirements.
    MutexOperation.TaskRunning An identical job is running.
    OperationDenied.InstanceOperationInProgress The instance has an operation in progress. Please try again later.
    UnsupportedOperation.ArmArchitecture This operation is currently not supported for ARM machines.
    UnsupportedOperation.EdgeZoneNotSupportCloudDisk The selected edge zone does not support cloud disk operations.
    UnsupportedOperation.InstanceReinstallFailed The current instance is in a failed OS reinstallation state and does not support this operation. We recommend reinstalling the operating system again. Alternatively, you may terminate/return the instance or submit a support ticket.
    UnsupportedOperation.InstanceStateBanning This CVM is blocked. Please submit a ticket.
    UnsupportedOperation.InstanceStateEnterRescueMode Instances are entering the rescue mode, and this operation is not supported.
    UnsupportedOperation.InstanceStateEnterServiceLiveMigrate The instance ins-xxxxxx in the ENTER_SERVICE_LIVE_MIGRATE status is not supported.
    UnsupportedOperation.InstanceStateExitRescueMode Instances are exiting from the rescue mode, and this operation is not supported.
    UnsupportedOperation.InstanceStateExitServiceLiveMigrate The instance ins-xxxxxx in the EXIT_SERVICE_LIVE_MIGRATE status is not supported.
    UnsupportedOperation.InstanceStateFreezing The operation is not supported for the frozen instances.
    UnsupportedOperation.InstanceStateRebooting The instances are being restarted, and this operation is not supported.
    UnsupportedOperation.InstanceStateRescueMode Instances in the rescue mode are not available for this operation.
    UnsupportedOperation.InstanceStateServiceLiveMigrate The instances are being migrated, and this operation is not supported.
    UnsupportedOperation.InstanceStateShutdown Isolated instances do not support this operation.
    UnsupportedOperation.InstanceStateStopping The instance is being shut down, and this operation is not supported.
    UnsupportedOperation.InstanceStateTerminating The instance is being terminated, and the operation is not supported.
    UnsupportedOperation.SpecialInstanceType This special instance type does not support the operation.
    UnsupportedOperation.StoppedModeStopCharging The instance does not support the no charges when shut down feature.

    帮助和支持

    本页内容是否解决了您的问题?

    填写满意度调查问卷,共创更好文档体验。

    文档反馈