Tenant Cloud Compute Cloud Virtual Machine Instance APIs ResetInstancesType

ResetInstancesType

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

1. Interface Description

Interface request domain name: cvm.api3.convergecloud.com.

This API (ResetInstancesType) is used to adjust the model of an instance.

  • Currently, only instances with System Disk Types of CLOUD_BASIC, CLOUD_PREMIUM, or CLOUD_SSD are supported for adjusting the model through this API.
  • Currently, CDH instances are not supported for adjusting the model through this API. * Currently, adjusting the model across model systems is not supported. In other words, when you use this API, the specified InstanceType and the original model of the instance need to belong to the same series. * For monthly subscription instances, using this API will involve charges. Make sure your account balance is sufficient.

Default interface request rate limit: 10 times per second.

Interface update time: 2020-12-10 07:43:59.

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: ResetInstancesType
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
InstanceIds Yes No Array of String One or more instance IDs to be operated. You can obtain the instance ID through the InstanceId in the returned value from the API DescribeInstances. A maximum of 1 batch instance per request is allowed.
Example: ["ins-r8hr2upy"]
InstanceType Yes No String Instance model. Different instance models specify different resource specifications. For specific values, see the attached instance resource specification comparison table. Alternatively, you can call the API for querying a list of instance resource specifications to obtain the latest specification table.
Example: S5.16XLARGE256
ForceStop No No Bool Whether to perform forced shutdown on the running instance. It is recommended to perform manual shutdown on the running instance first, and then reset the user password. Value Range:
  • TRUE: Indicates forced shutdown performed after normal shutdown fails.
  • FALSE: Indicates no forced shutdown performed after normal shutdown fails.

    Default value: FALSE.

    The effect of forced stop is equivalent to turning off the switch of the physical computer. Forced stop may lead to data loss or damage of the file system. Use it only when the server cannot be normally stopped.
    Example: false
    		•
    Online No No Bool Whether to upgrade the configuration online.
    Example: true
    IsAllowedAcrossHost No No Bool Whether to allow cross-host adjustment.
    Example: False

    3. Output Parameters

    Parameter name Type Description
    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
    InvalidPermission The account does not support this operation.
    InternalServerError Internal operation error.
    InvalidAccount.InsufficientBalance Insufficient account balance
    InvalidInstanceId.Malformed Invalid Instance ID. The format of the specified instance ID is incorrect, for example, an instance ID length error ins-1122.
    InvalidInstance.NotSupported Unsupported instance.
    InvalidParameterValue Invalid parameter value. The format of the parameter value is incorrect or not supported, etc.
    InvalidParameter Invalid parameter. The parameter does not meet the requirements, is not supported, or the like.
    MissingParameter Parameters are missing. The request did not include mandatory parameters.
    InvalidInstanceId.NotFound No corresponding instance was found.
    InvalidAccount.UnpaidOrder The account has unpaid orders.