Tenant Cloud Compute Cloud Virtual Machine Instance APIs ResetInstance

ResetInstance

Last Updated At: 2026-08-02 00:05:21

1. Interface Description

Interface request domain name: cvm.api3.convergecloud.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.
  • When switching between the Linux and Windows systems is performed, the system disk ID of the instance will change. If the system disk is associated with the snapshot, data cannot be rolled back and restored.
  • If you do not specify a password, a random password will be sent via Message Center.
  • Currently, only instances whose System Disk Type is CLOUD_BASIC, CLOUD_PREMIUM, or CLOUD_SSD are supported for implementing switching between the Linux and Windows operating systems through this API.
  • Currently, instances in overseas regions are not supported for implementing switching between the Linux and Windows operating systems through this API.

Default interface request rate limit: 10 times per second.

Interface update time: 2022-10-28 03:44:11.

The interface only verifies the signature but does not authenticate.

2. Input Parameters

The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.

Parameter name Required Allow NULL Type Description
Action Yes No String Public parameter, The value of this interface: ResetInstance
Version Yes No String Public parameter, The value of this interface: 2017-03-12
Region No No String Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface
InstanceId Yes No String Instance ID. Can be obtained through the InstanceId in the returned value from the API DescribeInstances.
Example: ins-r8hr2upy
ImageId No No String Specify a valid Image ID, in the format of img-xxx. There are four types of images:
  • Public Image
  • Custom Image
  • Shared Image
  • Service Market Image

    • You can obtain available image IDs in the following ways:
  • The image IDs for the Public Image, Custom Image, and Shared Image can be queried by logging in to the Console.
  • Through the ImageId field in the returned information by calling the API DescribeImages.

    • Example: img-pmqg1cw7
    SystemDisk No No SystemDisk Instance system disk configuration information. Instances whose system disk is a CBS can specify the system disk size after reinstallation through this parameter to perform expansion on the system disk. If not specified, the default system disk size retains unchanged. Only expanding the system disk size is supported, but reducing the system disk size is not supported. Reinstallation only supports modifying the system disk size but the system disk type.
    Example:View
    LoginSettings No No LoginSettings Instance login settings. You can set login method, password, or key of the instance or retain the original login settings of the image. By default, a password will be randomly generated and notified to the user through Message Center.
    Example:View
    EnhancedService No No EnhancedService Enhanced services. You can specify whether to enable services such as Cloud Security and Cloud Monitor through this parameter. If this parameter is not specified, the Cloud Monitor and Cloud Security is enabled by default.
    Example:View
    DryRun No No Bool Whether to skip the actual execution logic.
    Example: false

    3. Output Parameters

    Parameter name Type Description
    TaskId String Task ID
    Example: 435323
    flowId Int64 Task Flow ID
    Example: 4
    FlowId Int64 Task Flow ID
    Example: 4
    RequestId String Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem.

    4. Error Code

    The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.

    Error Code Description
    InvalidInstanceId.NotFound No corresponding instance was found.
    InvalidInstance.NotSupported Unsupported instance.
    InvalidParameterValue Invalid parameter value. The format of the parameter value is incorrect or not supported, etc.
    InternalServerError Internal operation error.
    InvalidInstanceId.Malformed Invalid Instance ID. The format of the specified instance ID is incorrect, for example, an instance ID length error ins-1122.
    MissingParameter Parameters are missing. The request did not include mandatory parameters.
    InvalidImageId.NotFound Image not found