Help & DocumentationCloud Virtual MachineAPI DocumentationInstance APIsResetInstance

ResetInstance

Last updated: 2020-03-16 18:27:22

PDF

Contents：

1. API Description

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

This API is used to reinstall the operating system of the specified instance.

  • If you specify an ImageId, the specified image is used. Otherwise, the image used by the current instance is used.
  • The system disk will be formatted and reset. Therefore, make sure that no important files are stored on the system disk.
  • If the operating system switches between Linux and Windows, the system disk ID of the instance will change, and the snapshots that are associated with the system disk can no longer be used to roll back and restore data.
  • If no password is specified, you will get a random password via internal message.
  • You can only use this API to switch the operating system between Linux and Windows for instances whose system disk type is CLOUD_BASIC, CLOUD_PREMIUM, or CLOUD_SSD.
  • Currently, this API only supports instances in Mainland China regions.

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

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: cvm.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: ResetInstance.
Version Yes String Common parameter. The value used for this API: 2017-03-12.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
InstanceId Yes String Instance ID. To obtain the instance IDs, you can call DescribeInstances and look for InstanceId in the response.
ImageId No String Image ID in the format of img-xxx. There are four types of images:
  • Public images
  • Custom images
  • Shared images
  • Marketplace images

    • You can obtain the available image IDs in the following ways:
  • For IDs of public images, custom images, and shared images, log in to the console to query the information; for IDs of marketplace images, go to Cloud Marketplace.
  • Call DescribeImages and look for ImageId in the response.


    • The current image will be used by default.
    SystemDisk No SystemDisk Configuration of the system disk of the instance. For instances with a cloud disk as the system disk, you can expand the system disk by using this parameter to specify the new capacity after reinstallation. If the parameter is not specified, the system disk capacity remains unchanged by default. You can only expand the capacity of the system disk; reducing its capacity is not supported. When reinstalling the system, you can only modify the capacity of the system disk, not the type.
    LoginSettings No LoginSettings Login settings of the instance. You can use this parameter to set the login method, password, and key of the instance or keep the login settings of the original image. By default, a random password will be generated and sent to you via the Message Center.
    EnhancedService No EnhancedService Enhanced services. You can use this parameter to specify whether to enable services such as Cloud Monitor and Cloud Security. If this parameter is not specified, Cloud Monitor and Cloud Security will be enabled by default.
    HostName No String You can use this parameter to specify a new HostName for the instance when reinstalling the system.

    3. Output Parameters

    Parameter Name Type Description
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Reinstalling an instance

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

    Input Example

    GET https://cvm.tencentcloudapi.com/?Action=ResetInstance
&InstanceId=ins-r8hr2upy
&ImageId=img-pmqg1cw7
&SystemDisk.DiskSize=60
&LoginSettings.Password=Qcloud@TestApi123++
&EnhancedService.SecurityService.Enabled=TRUE
&EnhancedService.MonitorService.Enabled=TRUE
&<common request parameters>

    Output Example

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

    5. Developer Resources

    API Explorer

    This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

    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
    InternalServerError Internal error.
    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.
    InvalidParameter.HostNameIllegal The specified HostName is invalid.
    InvalidParameter.InstanceImageNotSupport This API does not support instance images.
    InvalidParameterValue Invalid parameter value: parameter value is in the wrong format or is not supported.
    MissingParameter Missing parameter: a required parameter is missing.