tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

EnterRescueMode

Last updated: 2024-10-22 19:34:02

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.

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.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy