API 中心
有奖：语音产品征文挑战赛火热进行中> HOT
文档中心 > API 中心 > 轻量应用服务器 > 云硬盘相关接口 > 查询云硬盘

查询云硬盘

最近更新时间：2024-03-12 01:38:05

我的收藏

本页目录：

1. 接口描述

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

本接口（DescribeDisks）用于查询云硬盘信息。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeDisks。
Version 是 String 公共参数，本接口取值：2020-03-24。
Region 是 String 公共参数，详见产品支持的 地域列表。
DiskIds.N 否 Array of String 云硬盘ID列表。
示例值：["lhdisk-p1zflrif"]
Filters.N 否 Array of Filter 过滤器列表。
disk-id
按照【云硬盘 ID】进行过滤。
类型：String
必选：否
instance-id
按照【实例ID】进行过滤。
类型：String
必选：否
disk-name
按照【云硬盘名称】进行过滤。
类型：String
必选：否
zone
按照【可用区】进行过滤。
类型：String
必选：否
disk-usage
按照【云硬盘类型】进行过滤。
类型：String
必选：否
取值：SYSTEM_DISK或DATA_DISK
disk-state
按照【云硬盘状态】进行过滤。
类型：String
必选：否
取值：参考数据结构Disk中DiskState取值。
每次请求的 Filters 的上限为 10，Filter.Values 的上限为 100。参数不支持同时指定 DiskIds 和 Filters。
Limit 否 Integer 返回数量，默认为20，最大值为100。
示例值：100
Offset 否 Integer 偏移量，默认为0。
示例值：0
OrderField 否 String 云硬盘列表排序的依据字段。取值范围："CREATED_TIME"：依据云硬盘的创建时间排序。 "EXPIRED_TIME"：依据云硬盘的到期时间排序。"DISK_SIZE"：依据云硬盘的大小排序。默认按云硬盘创建时间排序。
示例值：CREATED_TIME
Order 否 String 输出云硬盘列表的排列顺序。取值范围："ASC"：升序排列。 "DESC"：降序排列。默认按降序排列。
示例值：ASC

3. 输出参数

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

4. 示例

示例1 查询磁盘

查询磁盘

输入示例

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

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

输出示例

{
    "Response": {
        "TotalCount": 1,
        "DiskSet": [
            {
                "DiskId": "lhdisk-p1zflrif",
                "InstanceId": "lhins-anxwfvxh",
                "Zone": "ap-guangzhou-3",
                "DiskName": "lhdisk-p1zflrif-system-disk",
                "DiskUsage": "DATA_DISK",
                "DiskType": "CLOUD_PREMIUM",
                "DiskChargeType": "PREPAID",
                "DiskSize": 30,
                "RenewFlag": "NOTIFY_AND_AUTO_RENEW",
                "DiskState": "ATTACHED",
                "Attached": true,
                "DeleteWithInstance": false,
                "DiskBackupCount": 1,
                "DiskBackupQuota": 1,
                "LatestOperation": "DetachDisks",
                "LatestOperationState": "FAILED",
                "LatestOperationRequestId": "54118bb6-7206-43f7-bf53-b77a394ad51e",
                "CreatedTime": "2021-08-25T08:50:57Z",
                "ExpiredTime": "2021-10-28T09:11:37Z",
                "IsolatedTime": null
            }
        ],
        "RequestId": "b362f486-571c-4094-afd5-22a38bd63046"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AuthFailure CAM签名/鉴权错误。
FailedOperation 操作失败。
InternalError.InvalidCommandNotFound 命令无法找到。
InvalidParameter.FilterValueLimitExceeded 参数非法，Filter 参数中的 Values 取值数量超过允许的最大数量。
InvalidParameter.InvalidFilter 参数非法，Filter 参数非法。
InvalidParameter.InvalidFilterInvalidKey 参数非法，Filter 参数中的 Name 取值非法。
InvalidParameter.ParameterConflict 参数非法，参数冲突。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.DiskNameTooLong 磁盘名称长度超出限制。
InvalidParameterValue.Duplicated 参数值非法，不允许包含重复的值。
InvalidParameterValue.InstanceIdMalformed 参数值非法，实例 ID 格式非法。
InvalidParameterValue.InvalidDiskIdMalformed 参数值非法，磁盘 ID 格式非法。
InvalidParameterValue.InvalidZone 参数Zone的取值不合法。
InvalidParameterValue.LimitExceeded 参数值非法，参数值的数量超过最大限制。
InvalidParameterValue.OutOfRange 参数值非法，不在合法范围内。
InvalidParameterValue.RegionNotFound 地域不存在。
InvalidParameterValue.RegionNotMatch 地域不匹配。
InvalidParameterValue.RegionNotSupported 不支持的地域。
InvalidParameterValue.RegionUnavailable 该地域不可用。
InvalidParameterValue.ZoneInvalid 非法的可用区。
ResourceNotFound.DiskIdNotFound 磁盘 ID 不存在。
UnauthorizedOperation.NoPermission 无权限。
中国站