帮你快速理解、总结文档立即下载
文档中心>云桌面>API 文档>实例管理相关接口>主动退还实例

主动退还实例

最近更新时间：2026-10-27 17:22:05
我的收藏

本页目录：

1. 接口描述

接口请求域名： cvd.tencentcloudapi.com 。

主动退还、销毁退还实例。

  • 包年包月实例首次调用本接口，且参数DestroyImmediately为false时，实例进入隔离期，再次调用本接口，实例将被销毁，且不可恢复。
  • 包年包月实例，如果参数DestroyImmediately为true来调用此接口，则实例将被直接销毁，且不可恢复。
  • 按量计费实例调用本接口将被直接销毁，且不可恢复。

    • 默认接口请求频率限制：20次/秒。

    推荐使用 API Explorer
    点击调试
    API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

    2. 输入参数

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

    参数名称 必选 类型 描述
    Action 是 String 公共参数，本接口取值：TerminateInstances。
    Version 是 String 公共参数，本接口取值：2020-11-04。
    Region 是 String 公共参数，详见产品支持的 地域列表。
    InstanceIds.N 是 Array of String

    一个或多个待操作的实例ID。每次请求批量实例的上限为10。


    示例值：["cvd-a"]
    DestroyImmediately 否 Boolean

    是否立即销毁实例。默认false。 立即销毁的实例不会进入隔离期。


    示例值：false

    3. 输出参数

    参数名称 类型 描述
    RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 主动退还实例

    输入示例

    POST / HTTP/1.1
Host: cvd.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: TerminateInstances
<公共请求参数>

{
    "InstanceIds": [
        "cvd-a"
    ]
}

    输出示例

    {
    "Response": {
        "RequestId": "0c4ca787-1b82-4988-9d89-2dac293e18fa"
    }
}

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    FailedOperation.SystemError 信令执行时发生错误,建议重试。
    InvalidParameterValue.LimitExceeded 参数取值错误，超过单次允许操作的最大数量。
    UnauthorizedOperation 未授权操作。
    UnauthorizedOperation.ServiceNotActivated 尚未开通该项服务，请先开通服务。
    UnsupportedOperation.InstanceState 实例当前的状态下不支持该操作。
    中国站