ResetInstancesType

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

1. API Description

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

This API is used to change the model of an instance.

  • You can only use this API to change the models of instances whose system disk type is CLOUD_BASIC, CLOUD_PREMIUM, or CLOUD_SSD.
  • Currently, you cannot use this API to change the models of CDH instances.

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: ResetInstancesType.
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.
InstanceIds.N Yes Array of String Instance ID(s). To obtain the instance IDs, you can call DescribeInstances and look for InstanceId in the response. The maximum number of instances in each request is 1.
InstanceType Yes String Instance model. Different resource specifications are specified for different models. For specific values, call DescribeInstanceTypeConfigs to get the latest specification list or refer to Instance Types.
ForceStop No Boolean Whether to force shut down a running instances. It is recommended to manually shut down a running instance before resetting the user password. Valid values:
  • TRUE: force shut down an instance after a normal shutdown fails.
  • FALSE: do not force shut down an instance after a normal shutdown fails.

    Default value: FALSE.

    A forced shutdown is similar to switching off the power of a physical computer. It may cause data loss or file system corruption. Be sure to only force shut down a CVM when it cannot be shut down normally.
  • 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 Reset the instance type

    When the configuration of current instance type does not meet your business needs, you can readjust it.

    Input Example

    GET https://cvm.tencentcloudapi.com/?Action=ResetInstancesType
    &InstanceIds.0=ins-r8hr2upy
    &InstanceType=S5.16XLARGE256
    &<common request parameters>

    Output Example

    {
      "Response": {
        "RequestId": "d39d6c09-44e9-4e80-8661-77b5ff3cbc15"
      }
    }

    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.
    InvalidAccount.UnpaidOrder The account has unpaid orders.
    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 Invalid parameter. The parameter does not meet the requirements or is not supported.
    InvalidParameterValue Invalid parameter value: parameter value is in the wrong format or is not supported.
    InvalidPermission This operation is not supported for the account.
    MissingParameter Missing parameter: a required parameter is missing.