API 中心

文档平台 API 中心云硬盘云硬盘相关接口退还云硬盘

退还云硬盘

最近更新时间：2019-02-22 14:30:35

在这篇文章中：

1. 接口描述

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

本接口（TerminateDisks）用于退还云硬盘。

不再使用的云盘，可通过本接口主动退还。
本接口支持退还预付费云盘和按小时后付费云盘。按小时后付费云盘可直接退还，预付费云盘需符合退还规则。
支持批量操作，每次请求批量云硬盘的上限为50。如果批量云盘存在不允许操作的，请求会以特定错误码返回。

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

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：TerminateDisks
Version	是	String	公共参数，本接口取值：2017-03-12
Region	是	String	公共参数，详见产品支持的地域列表。
DiskIds.N	是	Array of String	需退还的云盘ID列表。

3. 输出参数

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

4. 示例

示例1 批量退还云硬盘

输入示例

https://cbs.tencentcloudapi.com/?Action=TerminateDisks
&DiskIds.0=disk-lzrg2pwi
&DiskIds.1=disk-g27hqeo2
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "52c965d2-5deb-459a-8b5a-b3b9a1376544"
    }
}

5. 开发者资源

API Explorer

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

API 3.0 Explorer

SDK

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
InsufficientRefundQuota	云盘退还数量已达上限，不能再退还。
InternalError.FailQueryResource	查询资源失败。
InvalidDisk.Expire	云盘已过期。
InvalidDisk.NotSupportRefund	云盘不支持退还。
InvalidDisk.RepeatRefund	云盘已退还过，不能重复退还。
InvalidParameterValue	无效参数值。参数值格式错误或者参数值不被支持等。
MissingParameter	参数缺失。请求没有带必选参数。