退还实例

最近更新时间:2018-11-15 19:13:22

查看pdf

1. 接口描述

接口请求域名: cvm.tencentcloudapi.com 。

本接口 (TerminateInstances) 用于主动退还实例。

  • 不再使用的实例,可通过本接口主动退还。
  • 按量计费的实例通过本接口可直接退还;包年包月实例如符合退还规则,也可通过本接口主动退还。
  • 支持批量操作,每次请求批量实例的上限为100。

默认接口请求频率限制:10次/秒。

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:cvm.ap-shanghai-fsi.tencentcloudapi.com 。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:TerminateInstances
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,详见产品支持的地域列表
InstanceIds.N Array of String 一个或多个待操作的实例ID。可通过DescribeInstances接口返回值中的InstanceId获取。每次请求批量实例的上限为100。

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 销毁指定ID的实例

输入示例

https://cvm.tencentcloudapi.com/?Action=TerminateInstances
&InstanceIds.0=ins-r8hr2upy
&InstanceIds.1=ins-5d8a23rs
&<公共请求参数>

输出示例

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

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码

错误码 描述
InternalServerError 操作内部错误。
InvalidInstance.NotSupported 不被支持的实例。
InvalidInstanceId.Malformed 无效实例ID。指定的实例ID格式错误。例如实例ID长度错误ins-1122
InvalidInstanceNotSupportedPrepaidInstance 该实例不满足包月退还规则
InvalidParameterValue 无效参数值。参数值格式错误或者参数值不被支持等。
InvalidParameterValue.LimitExceeded 参数值数量超过限制。
MissingParameter 参数缺失。请求没有带必选参数。