- Tutorial
- Release Notes and Announcements
- Release Notes
- Public Image Release Notes
- Announcements
- Temporary Solution for the Windows Blue Screen Issue Caused by CrowdStrike Security Software on July 19, 2024
- Announcement on Flexible Discounts for Spot Instances in Some Regions
- Updating Some Image Pip Package Management Tools for CentOS 7
- CentOS 8 End of Maintenance
- Discontinuation of Support for SUSE Commercial Images
- Price Reduction in Selected Availability Zones
- OrcaTerm Proxy IP Addresses Updates
- Pay-as-you-go Price Adjustments for Standard S3 CVMs in the Silicon Valley Region
- Vulnerability repairing for Linux images
- Stopping supporting for Ubuntu 10.04 images
- Solution to Tomcat Start Failure on Ubuntu14.04
- Upgrading Virtio network card drive for Windows CVMs
- About Configuration of Security Group Port 53
- Windows Server 2003 System Images End of Support Announcement
- End of Support for Windows Server 2008 R2 Enterprise Edition SP1 64-bit System Images
- Product Introduction
- Purchase Guide
- Getting Started
- Operation Guide
- Operation Guide Overview
- Use Limits
- Convenience Features
- Instances
- Creating Instances
- Managing Instance Launch Template
- Batch Sequential Naming or Pattern String-Based Naming
- Logging In to Linux Instances
- Logging in to Windows instance
- Adjusting Configuration
- View Instance Details
- Renaming Instances
- Resetting Instance Password
- Managing Instance IPs
- Changing Security Group
- Conversion from Pay-As-You-Go to Monthly Subscription
- Searching for Instances
- Exporting Instance List
- Renewing Instances
- Starting Up Instances
- Shutting Down Instances
- Restarting Instances
- Reinstalling System
- Using Tencent Cloud Automation Tools to execute commands
- Terminating/Returning Instances
- Enabling Instance Termination Protection
- Instance Repossession or Recovering
- Spot Instances
- Querying the Repossession Status of a Spot Instance
- No Charges When Shut Down for Pay-as-You-Go Instances
- Managing Roles
- Enabling and Disabling Hyper-Threading
- Reserved Instances
- Images
- Migrating Servers
- Maintenance Tasks
- Cloud Disks
- Networking
- Security
- Security Groups
- Protection of Sensitive Operations
- Managing Login Password
- Managing SSH Keys
- Spread Placement Group
- Unblocking Port 25
- Tags
- Monitoring and Alarms
- Sample Console Configuration
- Practical Tutorial
- Best Practices
- Choosing the CVM Model
- Setting up a Website
- Building an Environment
- Building a Website
- Building an Application
- Sending Emails through Port 465
- Building a Visual GUI
- Data Backup
- Uploading Local Files to CVM
- Copying Local Files to CVMs
- Uploading Files from Windows to a Windows CVM via MSTSC
- Uploading Files from MacOS to Windows CVM Using MRD
- Uploading Files from Linux to Windows CVM using RDP
- Uploading files via WinSCP to a Linux CVM from Windows
- Uploading Files from Linux or MacOS to Linux CVM via SCP
- Uploading Files from Linux to a CVM Using FTP
- Uploading Files from Windows to a CVM Using FTP
- Other CVM Operations
- CVM Access to COS via a Private Network
- Best Practices for Boot Mode Legacy BIOS and UEFI
- Recovering Data on Linux CVMs
- Managing Disk Space on Windows CVMs
- Changing Kernel of a Linux Instance Manually
- Setting Up Windows-based AD Domain on a CVM
- Network Performance Test
- High-throughput Network Performance Test
- Using USB/IP to Share USB Devices in Linux
- Using RemoteFx to Redirect USB Devices in Windows
- Using AVX-512 Instructions to Accelerate AI Applications on CVM
- Building Tencent SGX Confidential Computing Environment
- Configuring Persistent Memory in M6p Instances
- Calling Cloud APIs via Python to Share Custom Images in Batches
- Operations Guide
- Initializing Data Disks
- Environment Configurations
- Installing Software
- User Data
- Work with Operating Systems
- System Activation
- System Updates
- System Shutdown
- Configuring High-performance Power Management
- Windows Recovery Mode
- Updating the Virtio ENI Driver
- Modifying SID
- Modifying VNC Resolution
- Ensuring Unique SIDs for CVMs Using Sysprep
- Use of the atop Monitoring Tools by Linux Instances
- Introduction to Linux Kernel Parameters
- Others
- Troubleshooting
- Instance-Related Failures
- CVM Login Failures
- Windows Instance Login Failures
- Windows Instance Login Failures
- An authentication error occurred when you tried to log in to a Windows instance remotely
- Failed to Reset the CVM Password or the CVM Password Is Invalid
- Connection to a Windows CVM through Remote Desktop was denied
- Requires network-level identity verification
- Problems occurred when you tried to log in to a Windows CVM remotely on Mac
- Failed to log in to a Windows CVM due to high CPU and memory usage
- Failed to connect to a remote computer through Remote Desktop
- Credentials Not Work
- Windows instance: no remote Desktop license server can provide license
- Remote Login Failure Due To Port Issues
- Linux Instance Login Failures
- Linux Instance Login Failures
- Unable to Log in to a Linux Instance via SSH Key
- Failing to log in to a Linux CVM due to high CPU and memory usage
- Remote Login Failure due to Port Issues
- VNC Login Error (Module is Unknown)
- VNC Login Error (Account Locked due to XXX Failed Logins)
- VNC Login Error (Login Failed with Correct Password)
- VNC or SSH Login Error (Permission Denied)
- Login Failure Due to /etc/fstab Configuration Errors
- sshd Configuration File Permissions
- Infinite Loop Call in /etc/profile
- Login Failure Due to Server Isolation
- Login Failure Due to High Bandwidth Occupation
- Remote Connect Failure Due to Security Group Settings
- Troubleshooting Linux Instance Issues via VNC and Rescue Mode
- Failed to shut down or restart a CVM
- Network Namespace Creation Failure
- Kernel and IO Issues
- Missing System bin or lib Soft Link
- Suspected Infection with Virus
- "no space left on device" Error During File Creation
- Linux CVM Memory Issues
- Network Related Failures
- Instance-Related Failures
- API Documentation
- History
- Introduction
- API Category
- Region APIs
- Instance APIs
- RunInstances
- DescribeInstances
- DescribeInstanceFamilyConfigs
- DescribeInstancesOperationLimit
- InquiryPriceRunInstances
- InquiryPriceResetInstance
- InquiryPriceResetInstancesType
- StartInstances
- RebootInstances
- StopInstances
- ResizeInstanceDisks
- ResetInstancesPassword
- ModifyInstancesAttribute
- EnterRescueMode
- ExitRescueMode
- InquirePricePurchaseReservedInstancesOffering
- InquiryPriceResizeInstanceDisks
- TerminateInstances
- ModifyInstancesProject
- ResetInstancesType
- DescribeInstancesStatus
- DescribeReservedInstancesConfigInfos
- DescribeZoneInstanceConfigInfos
- PurchaseReservedInstancesOffering
- ResetInstance
- DescribeInstanceTypeConfigs
- DescribeInstanceVncUrl
- Cloud Hosting Cluster APIs
- Image APIs
- Instance Launch Template APIs
- Making API Requests
- Placement Group APIs
- Key APIs
- Security Group APIs
- Network APIs
- Data Types
- Error Codes
- FAQs
- Related Agreement
- Glossary
- Tutorial
- Release Notes and Announcements
- Release Notes
- Public Image Release Notes
- Announcements
- Temporary Solution for the Windows Blue Screen Issue Caused by CrowdStrike Security Software on July 19, 2024
- Announcement on Flexible Discounts for Spot Instances in Some Regions
- Updating Some Image Pip Package Management Tools for CentOS 7
- CentOS 8 End of Maintenance
- Discontinuation of Support for SUSE Commercial Images
- Price Reduction in Selected Availability Zones
- OrcaTerm Proxy IP Addresses Updates
- Pay-as-you-go Price Adjustments for Standard S3 CVMs in the Silicon Valley Region
- Vulnerability repairing for Linux images
- Stopping supporting for Ubuntu 10.04 images
- Solution to Tomcat Start Failure on Ubuntu14.04
- Upgrading Virtio network card drive for Windows CVMs
- About Configuration of Security Group Port 53
- Windows Server 2003 System Images End of Support Announcement
- End of Support for Windows Server 2008 R2 Enterprise Edition SP1 64-bit System Images
- Product Introduction
- Purchase Guide
- Getting Started
- Operation Guide
- Operation Guide Overview
- Use Limits
- Convenience Features
- Instances
- Creating Instances
- Managing Instance Launch Template
- Batch Sequential Naming or Pattern String-Based Naming
- Logging In to Linux Instances
- Logging in to Windows instance
- Adjusting Configuration
- View Instance Details
- Renaming Instances
- Resetting Instance Password
- Managing Instance IPs
- Changing Security Group
- Conversion from Pay-As-You-Go to Monthly Subscription
- Searching for Instances
- Exporting Instance List
- Renewing Instances
- Starting Up Instances
- Shutting Down Instances
- Restarting Instances
- Reinstalling System
- Using Tencent Cloud Automation Tools to execute commands
- Terminating/Returning Instances
- Enabling Instance Termination Protection
- Instance Repossession or Recovering
- Spot Instances
- Querying the Repossession Status of a Spot Instance
- No Charges When Shut Down for Pay-as-You-Go Instances
- Managing Roles
- Enabling and Disabling Hyper-Threading
- Reserved Instances
- Images
- Migrating Servers
- Maintenance Tasks
- Cloud Disks
- Networking
- Security
- Security Groups
- Protection of Sensitive Operations
- Managing Login Password
- Managing SSH Keys
- Spread Placement Group
- Unblocking Port 25
- Tags
- Monitoring and Alarms
- Sample Console Configuration
- Practical Tutorial
- Best Practices
- Choosing the CVM Model
- Setting up a Website
- Building an Environment
- Building a Website
- Building an Application
- Sending Emails through Port 465
- Building a Visual GUI
- Data Backup
- Uploading Local Files to CVM
- Copying Local Files to CVMs
- Uploading Files from Windows to a Windows CVM via MSTSC
- Uploading Files from MacOS to Windows CVM Using MRD
- Uploading Files from Linux to Windows CVM using RDP
- Uploading files via WinSCP to a Linux CVM from Windows
- Uploading Files from Linux or MacOS to Linux CVM via SCP
- Uploading Files from Linux to a CVM Using FTP
- Uploading Files from Windows to a CVM Using FTP
- Other CVM Operations
- CVM Access to COS via a Private Network
- Best Practices for Boot Mode Legacy BIOS and UEFI
- Recovering Data on Linux CVMs
- Managing Disk Space on Windows CVMs
- Changing Kernel of a Linux Instance Manually
- Setting Up Windows-based AD Domain on a CVM
- Network Performance Test
- High-throughput Network Performance Test
- Using USB/IP to Share USB Devices in Linux
- Using RemoteFx to Redirect USB Devices in Windows
- Using AVX-512 Instructions to Accelerate AI Applications on CVM
- Building Tencent SGX Confidential Computing Environment
- Configuring Persistent Memory in M6p Instances
- Calling Cloud APIs via Python to Share Custom Images in Batches
- Operations Guide
- Initializing Data Disks
- Environment Configurations
- Installing Software
- User Data
- Work with Operating Systems
- System Activation
- System Updates
- System Shutdown
- Configuring High-performance Power Management
- Windows Recovery Mode
- Updating the Virtio ENI Driver
- Modifying SID
- Modifying VNC Resolution
- Ensuring Unique SIDs for CVMs Using Sysprep
- Use of the atop Monitoring Tools by Linux Instances
- Introduction to Linux Kernel Parameters
- Others
- Troubleshooting
- Instance-Related Failures
- CVM Login Failures
- Windows Instance Login Failures
- Windows Instance Login Failures
- An authentication error occurred when you tried to log in to a Windows instance remotely
- Failed to Reset the CVM Password or the CVM Password Is Invalid
- Connection to a Windows CVM through Remote Desktop was denied
- Requires network-level identity verification
- Problems occurred when you tried to log in to a Windows CVM remotely on Mac
- Failed to log in to a Windows CVM due to high CPU and memory usage
- Failed to connect to a remote computer through Remote Desktop
- Credentials Not Work
- Windows instance: no remote Desktop license server can provide license
- Remote Login Failure Due To Port Issues
- Linux Instance Login Failures
- Linux Instance Login Failures
- Unable to Log in to a Linux Instance via SSH Key
- Failing to log in to a Linux CVM due to high CPU and memory usage
- Remote Login Failure due to Port Issues
- VNC Login Error (Module is Unknown)
- VNC Login Error (Account Locked due to XXX Failed Logins)
- VNC Login Error (Login Failed with Correct Password)
- VNC or SSH Login Error (Permission Denied)
- Login Failure Due to /etc/fstab Configuration Errors
- sshd Configuration File Permissions
- Infinite Loop Call in /etc/profile
- Login Failure Due to Server Isolation
- Login Failure Due to High Bandwidth Occupation
- Remote Connect Failure Due to Security Group Settings
- Troubleshooting Linux Instance Issues via VNC and Rescue Mode
- Failed to shut down or restart a CVM
- Network Namespace Creation Failure
- Kernel and IO Issues
- Missing System bin or lib Soft Link
- Suspected Infection with Virus
- "no space left on device" Error During File Creation
- Linux CVM Memory Issues
- Network Related Failures
- Instance-Related Failures
- API Documentation
- History
- Introduction
- API Category
- Region APIs
- Instance APIs
- RunInstances
- DescribeInstances
- DescribeInstanceFamilyConfigs
- DescribeInstancesOperationLimit
- InquiryPriceRunInstances
- InquiryPriceResetInstance
- InquiryPriceResetInstancesType
- StartInstances
- RebootInstances
- StopInstances
- ResizeInstanceDisks
- ResetInstancesPassword
- ModifyInstancesAttribute
- EnterRescueMode
- ExitRescueMode
- InquirePricePurchaseReservedInstancesOffering
- InquiryPriceResizeInstanceDisks
- TerminateInstances
- ModifyInstancesProject
- ResetInstancesType
- DescribeInstancesStatus
- DescribeReservedInstancesConfigInfos
- DescribeZoneInstanceConfigInfos
- PurchaseReservedInstancesOffering
- ResetInstance
- DescribeInstanceTypeConfigs
- DescribeInstanceVncUrl
- Cloud Hosting Cluster APIs
- Image APIs
- Instance Launch Template APIs
- Making API Requests
- Placement Group APIs
- Key APIs
- Security Group APIs
- Network APIs
- Data Types
- Error Codes
- FAQs
- Related Agreement
- Glossary
1. API Description
Domain name for API request: cvm.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. |
| 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 |
| ForceStop | No | Boolean | Whether to perform forced shutdown. |
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.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: EnterRescueMode
<Common request parameters>
{
"InstanceId": "instance_Id",
"Password": "\"uu7797UUX\""
}
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.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
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 | |
| 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. |
Yes
No
Was this page helpful?