Domain name for API request: cvm.tencentcloudapi.com.
This API is used to return instances.
A maximum of 10 requests can be initiated per second for this API.
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 Params. The value used for this API: TerminateInstances. |
Version | Yes | String | Common Params. The value used for this API: 2017-03-12. |
Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
InstanceIds.N | Yes | Array of String | One or more instance IDs to be operated. You can obtain the instance ID through the InstanceId in the return value from the API DescribeInstances. The maximum number of instances per request is 100. |
ReleasePrepaidDataDisks | No | Boolean | Whether to release a monthly subscription data disk mounted on an instance. true: Release the data disk along with termination of the instance. false: Only terminate the instance. Default value: false . |
Parameter Name | Type | Description |
---|---|---|
RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
This example shows you how to terminate an instance by specifying the ID.
POST / HTTP/1.1
Host: cvm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: TerminateInstances
<Common request parameters>
{
"InstanceIds": [
"ins-3jaw1j8m"
]
}
{
"Response": {
"RequestId": "9a2f76a2-3b5b-4760-a90b-eff0c611b360"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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.InvalidInstanceApplicationRole | |
FailedOperation.InvalidInstanceApplicationRoleEmr | The EMR instance ins-xxxxxxxx does not support this operation. |
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.InstanceIdMalformed | Invalid instance ID. Please enter a valid ID, such as ins-xxxxxxxx (“x” represents a lower-case letter or a number). |
InvalidParameterValue.InvalidAppIdFormat | Invalid AppID |
InvalidParameterValue.LimitExceeded | The number of parameter values exceeds the limit. |
InvalidParameterValue.NotSupported | Unsupported operation. |
LimitExceeded.UserReturnQuota | Failed to return instances because of the quota limit. |
MissingParameter | Missing parameter. |
MutexOperation.TaskRunning | An identical job is running. |
OperationDenied.InstanceOperationInProgress | The instance has an operation in progress. Please try again later. |
UnauthorizedOperation.InvalidToken | Check if the token is valid. |
UnauthorizedOperation.MFAExpired | Unauthorized operation. Make sure Multi-Factor Authentication (MFA) is valid. |
UnauthorizedOperation.MFANotFound | Unauthorized operation. Make sure Multi-Factor Authentication (MFA) exists. |
UnsupportedOperation | Unsupported operation. |
UnsupportedOperation.InstanceChargeType | This instance billing mode does not support the operation. |
UnsupportedOperation.InstanceMixedPricingModel | A mixed payment mode is not supported. |
UnsupportedOperation.InstanceStateBanning | This CVM is blocked. Please submit a ticket. |
UnsupportedOperation.InstanceStateEnterRescueMode | Instances are entering the rescue mode, and this operation is not supported. |
UnsupportedOperation.InstanceStateEnterServiceLiveMigrate | The instance ins-xxxxxx in the ENTER_SERVICE_LIVE_MIGRATE status is not supported. |
UnsupportedOperation.InstanceStateExitRescueMode | Instances are exiting from the rescue mode, and this operation is not supported. |
UnsupportedOperation.InstanceStateExitServiceLiveMigrate | The instance ins-xxxxxx in the EXIT_SERVICE_LIVE_MIGRATE status is not supported. |
UnsupportedOperation.InstanceStateFreezing | The operation is not supported for the frozen instances. |
UnsupportedOperation.InstanceStateIsolating | Unable to isolate: the instance is isolated |
UnsupportedOperation.InstanceStateLaunchFailed | The instance is failed to create, so the 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.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.InstanceStateTerminated | Terminated instances are not supported. |
UnsupportedOperation.InstanceStateTerminating | The instance is being terminated, and the operation is not supported. |
UnsupportedOperation.InstancesProtected | The instance is under termination protection and cannot be terminated. Disable the termination protection and try again. |
UnsupportedOperation.InvalidInstancesOwner | The user does not have permissions to operate the current instance. |
UnsupportedOperation.RedHatInstanceTerminateUnsupported | An instance with an enterprise operating system installed cannot be returned. |
UnsupportedOperation.RedHatInstanceUnsupported | The operating system of the instance is RedHat, so this operation is not supported. |
UnsupportedOperation.Region | The region is unsupported. |
UnsupportedOperation.SpecialInstanceType | This special instance type does not support the operation. |
UnsupportedOperation.UserLimitOperationExceedQuota | The quota of user limit operations is insufficient. |
Was this page helpful?