轻量应用服务器查看云硬盘是否可退还-云硬盘相关接口-API 中心-腾讯云

1. 接口描述

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

本接口（DescribeDisksReturnable）用于查询云硬盘是否可退还。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeDisksReturnable。
Version	是	String	公共参数，本接口取值：2020-03-24。
Region	是	String	公共参数，详见产品支持的地域列表。
DiskIds.N	否	Array of String	云硬盘ID列表。每次批量请求云硬盘的上限为 10。可通过DescribeDisks接口返回值中的DiskId获取。示例值：["lhdisk-eobj8huv"]
Limit	否	Integer	返回数量，默认为20，最大值为100。示例值：20
Offset	否	Integer	偏移量，默认为0。示例值：0

3. 输出参数

参数名称	类型	描述
DiskReturnableSet	Array of DiskReturnable	可退还云硬盘详细信息列表。
TotalCount	Integer	符合条件的云硬盘数量。示例值：1
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询磁盘是否可退还

输入示例

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

{
    "DiskIds": [
        "lhdisk-eobj8huv"
    ]
}

输出示例

{
    "Response": {
        "TotalCount": 1,
        "DiskReturnableSet": [
            {
                "DiskId": "lhdisk-5vmz00i3",
                "IsReturnable": true,
                "ReturnFailCode": 0,
                "ReturnFailMessage": ""
            }
        ],
        "RequestId": "3eec6c10-a8c7-41e4-b4ba-c84a5000211d"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation.DescribeDisksReturnableError	查询云硬盘是否可以退还操作失败。
InvalidParameterValue.InvalidDiskIdMalformed	参数值非法，磁盘 ID 格式非法。
InvalidParameterValue.OutOfRange	参数值非法，不在合法范围内。
UnauthorizedOperation.NoPermission	无权限。

查看云硬盘是否可退还

本页目录：