tencent cloud

1. API Description

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

This API (ResetInstance) is used to reinstall the operating system on a specified instance.

• If you have specified the parameter ImageId, use the specified image for reinstallation. Otherwise, perform reinstallation based on the image currently used by the instance.
• The system disk will be formatted and reset. Ensure that there are no important files in the system disk.
• If you do not specify a password, a random password will be sent via Message Center.
• Currently, only instances with a system disk type of CLOUD_BASIC, CLOUD_PREMIUM, CLOUD_SSD, or CLOUD_BSSD are supported for implementing operating system switching through this API.
• You can query the result of the instance operation by calling the API DescribeInstances. If the latest operation status (LatestOperationState) of the instance is SUCCESS, the operation is successful.

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

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.

3. Output Parameters

4. Example

Example1 Reinstalling an instance

This example shows you how to reinstall an instance using the specified image, login password, and enhanced services, and expand the system disk of the instance.

Input Example

POST / HTTP/1.1
Host: cvm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ResetInstance
<Common request parameters>

{
    "InstanceId": "ins-r8hr2upy",
    "SystemDisk": {
        "DiskSize": "60"
    },
    "EnhancedService": {
        "SecurityService": {
            "Enabled": "TRUE"
        },
        "MonitorService": {
            "Enabled": "TRUE"
        }
    },
    "LoginSettings": {
        "Password": "Qcloud@TestApi123++"
    },
    "ImageId": "img-pmqg1cw7"
}

Output Example

{
    "Response": {
        "RequestId": "a0a66377-b79f-4a21-846c-d997d6022968"
    }
}

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

• Tencent Cloud CLI 3.0

6. Error Code

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