TerminateInstances

Last updated: 2021-01-18 11:59:37

1. API Description

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

This API is used to return instances.

  • Use this API to return instances that are no longer required.
  • Pay-as-you-go instances can be returned directly through this API.
  • When this API is called for the first time, the instance will be moved to the recycle bin. When this API is called for the second time, the instance will be terminated and cannot be recovered.
  • Batch operations are supported. The allowed maximum number of instances in each request is 100.

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: TerminateInstances.
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 100.

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 Terminating instances with the specific IDs

Input Example

GET https://cvm.tencentcloudapi.com/?Action=TerminateInstances
&InstanceIds.0=ins-r8hr2upy
&InstanceIds.1=ins-5d8a23rs
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "6ef60bec-0242-43af-bb20-270359fb54a7"
  }
}

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

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.Unreturnable The instance is unreturnable.
InternalError.TradeUnknownError Internal error.
InternalServerError Internal error.
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.
InvalidInstanceNotSupportedPrepaidInstance This instance does not meet the Return Policy for prepaid instances.
InvalidParameterValue Incorrect parameter value.
InvalidParameterValue.LimitExceeded The number of parameter values exceeds the limit.
InvalidParameterValue.NotSupported Unsupported operation.
MissingParameter Missing parameter.
MutexOperation.TaskRunning An identical job is running.
OperationDenied.InstanceOperationInProgress The instance has an operation in progress. Please try again later.
UnauthorizedOperation.MFAExpired Unauthorized operation. Make sure Multi-Factor Authentication (MFA) is valid.
UnauthorizedOperation.MFANotFound Unauthorized operation. Make sure Multi-Factor Authentication (MFA) exists.
UnsupportedOperation.InstanceStateEnterRescueMode Instances are entering the rescue mode, and this operation is not supported.
UnsupportedOperation.InstanceStatePending The instances are being created, and this operation is not supported.
UnsupportedOperation.InstanceStateRebooting The instances are being restarted, and this operation is not supported.
UnsupportedOperation.InstanceStateStopping The instance is being shut down, and this operation is not supported.
UnsupportedOperation.InstanceStateTerminated Terminated instances are not supported.
UnsupportedOperation.InstanceStateTerminating The instance is being terminated, and the operation is not supported.
UnsupportedOperation.Region The region is unsupported.
UnsupportedOperation.SpecialInstanceType This special instance type does not support the operation.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help