ResetInstance

Last updated: 2020-09-17 17:54:13

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

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 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 Specified effective 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 CVM console; for IDs of marketplace images, go to Cloud Marketplace.
  • Call the API DescribeImages and look for ImageId in the response.


  • Default value: current image.
    SystemDisk No SystemDisk System disk configurations in the instance. For instances with a cloud disk as the system disk, you can expand the capacity of the system disk to the specified value after re-installation by using this parameter. If the parameter is not specified, lower system disk capacity will be automatically expanded to the image size, and extra disk costs are generated. You can only expand but cannot reduce the system disk capacity. By re-installing the system, you only modify the system disk capacity, but 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 Host name of the CVM, editable during the system reinstallation.
  • Periods (.) or hyphens (-) cannot be the start or end of a host name or appear consecutively in a host name.
  • For Windows instances, the host name must consist of 2-15 characters , including uppercase and lowercase letters, numbers, or hyphens (-). It cannot contain periods (.) or contain only numbers.
  • For other instances, such as Linux instances, the host name must consist of 2-60 characters, including multiple periods (.), and allows uppercase and lowercase letters, numbers, or hyphens (-) between any two periods (.).
  • 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.
    InvalidAccount.InsufficientBalance Insufficient account balance.
    InvalidImageId.Malformed Invalid image ID format.
    InvalidImageId.NotFound The image cannot be found.
    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.
    InvalidParameterValue.IllegalHostName Invalid parameter HostName.
    InvalidParameterValue.InvalidImageState Invalid image status.
    InvalidPassword Invalid password. The specified password does not meet the password requirements. For example, the password length does not meet the requirements.
    MissingParameter Missing parameter: a required parameter is missing.
    MutexOperation.TaskRunning An identical job is running.
    OperationDenied.InstanceOperationInProgress The instance has an operation in progress. Please try again later.
    UnauthorizedOperation.MFAExpired Unauthorized operation. Make sure Multi-Factor Authentication (MFA) is valid.
    UnauthorizedOperation.MFANotFound Unauthorized operation. Make sure Multi-Factor Authentication (MFA) exists.
    UnsupportedOperation.InstanceStateRebooting The restarting instances do not support this operation.
    UnsupportedOperation.InstanceStateServiceLiveMigrate The instances that are migrating services do not support this operation.
    UnsupportedOperation.InstanceStateShutdown The isolated instances do not support this operation.
    UnsupportedOperation.InstanceStateStopping The stopping instances do not support this operation.
    UnsupportedOperation.KeyPairUnsupportedWindows The Windows operating system does not use key.
    UnsupportedOperation.StoppedModeStopCharging The instance does not support the no charges when shut down feature.

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback
    Help