ResetInstancesType

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

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

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: 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). You can obtain the instance IDs from the value of InstanceId returned by the DescribeInstances API. The maximum number of instances for 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 Forced shutdown of a running instances. We recommend you firstly try to shut down a running instance manually. Valid values:
  • TRUE: forced shutdown of an instance after a normal shutdown fails.
  • FALSE: no forced shutdown of 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 a CVM to shut off if the normal shutdown fails.
  • 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 Resetting the instance model

    This example shows you how to adjust the configuration of an instance that fails to meet your business needs.

    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
    InternalError.TradeUnknownError Internal error.
    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.
    InvalidParameterValue.LimitExceeded The number of parameter values exceeds the limit.
    InvalidPermission This operation is not supported for the account.
    MissingParameter Missing parameter: a required parameter is missing.
    OperationDenied.InstanceOperationInProgress The instance has an operation in progress. Please try again later.
    ResourceInsufficient.SpecifiedInstanceType The specified instance type is out of stock.
    ResourcesSoldOut.AvailableZone The availability zone has been sold out.
    ResourcesSoldOut.SpecifiedInstanceType The specified instance type has already been sold out.
    UnauthorizedOperation.MFAExpired Unauthorized operation. Make sure Multi-Factor Authentication (MFA) is valid.
    UnauthorizedOperation.MFANotFound Unauthorized operation. Make sure Multi-Factor Authentication (MFA) exists.
    UnsupportedOperation.InstanceStateRunning The running instances do not support this operation.
    UnsupportedOperation.InstanceStateStopping The stopping instances do not support this operation.
    UnsupportedOperation.SpecialInstanceType
    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