ResetInstancesType

Prev Next

search by keyword

Recent Pages

Documentation

Download PDF

Last updated: 2021-10-27 15:54:34

Download PDF

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.

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). To obtain the instance IDs, you can call the `DescribeInstances` API and find the value `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	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

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

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
FailedOperation.PromotionalPerioRestriction	The configuration or billing mode of the CVM instances purchased during the promotion period cannot be modified.
InternalError.TradeUnknownError	Internal error.
InternalServerError	Internal error.
InvalidAccount.InsufficientBalance	Insufficient account balance.
InvalidAccount.UnpaidOrder	The account has unpaid orders.
InvalidHostId.Malformed	Invalid CDH `ID`. The specified CDH `ID` has an invalid format. For example, `host-1122` has an invalid `ID` length.
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.
InvalidInstanceType.Malformed	The specified `InstanceType` parameter has an invalid format.
InvalidParameter	A parameter error occurred.
InvalidParameterValue	Incorrect parameter value.
InvalidParameterValue.GPUInstanceFamily	Non-GPU instances cannot be changed to the GPU instance.
InvalidParameterValue.LimitExceeded	The number of parameter values exceeds the limit.
InvalidParameterValue.ZoneNotSupported	The availability zone does not support this operation.
InvalidPermission	This operation is not supported for the account.
InvalidZone.MismatchRegion	The specified `zone` does not exist.
LimitExceeded.EniNumLimit	The number of ENIs on a specified instance exceeds the maximum ENIs allowed for the target instance type. Delete some ENIs and try again.
LimitExceeded.InstanceTypeBandwidth	Unable to adjust: the target instance type does not support the configured public network bandwidth cap. See Public Network Bandwidth Cap.
MissingParameter	Missing parameter.
OperationDenied.InstanceOperationInProgress	The instance has an operation in progress. Please try again later.
ResourceInsufficient.SpecifiedInstanceType	The specified instance type is insufficient.
ResourceUnavailable.InstanceType	This instance type is unavailable in the availability zone.
ResourcesSoldOut.AvailableZone	Resources in this availability zone has been sold out.
ResourcesSoldOut.SpecifiedInstanceType	The specified instance type is 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.InstanceStateRebooting	The instances are being restarted, and this operation is not supported.
UnsupportedOperation.InstanceStateRescueMode	Instances in the rescue mode are not available for this operation.
UnsupportedOperation.InstanceStateRunning	Running instances do not support this operation.
UnsupportedOperation.InstanceStateShutdown	Isolated instances do not support this operation.
UnsupportedOperation.InstanceStateStarting	The instance is starting up, and this operation is not supported.
UnsupportedOperation.InstanceStateStopping	The instance is being shut down, and this operation is not supported.
UnsupportedOperation.InstanceStateTerminating	The instance is being terminated, and the operation is not supported.
UnsupportedOperation.NoInstanceTypeSupportSpot	This instance type does not support spot instances.
UnsupportedOperation.SpecialInstanceType	This special instance type does not support the operation.
UnsupportedOperation.StoppedModeStopCharging	The instance does not support the no charges when shut down feature.
UnsupportedOperation.UnsupportedChangeInstanceFamily	The specified model does not support cross-model configuration adjustment.
UnsupportedOperation.UnsupportedChangeInstanceFamilyToARM	Non-ARM model instances cannot be changed to the ARM model.
UnsupportedOperation.UnsupportedChangeInstanceFamilyToSA3	The target model (SA3) does not support configuration adjustment.

Recent Pages