有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

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

本接口(DescribeDisks)用于查询云硬盘列表。

  • 可以根据云硬盘ID、云硬盘类型或者云硬盘状态等信息来查询云硬盘的详细信息,不同条件之间为与(AND)的关系,过滤信息详细请见过滤器Filter
  • 如果参数为空,返回当前用户一定数量(Limit所指定的数量,默认为20)的云硬盘列表。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDisks。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
Filters.N Array of Filter 过滤条件。参数不支持同时指定DiskIdsFilters
  • disk-usage - Array of String - 是否必填:否 -(过滤条件)按云盘类型过滤。 (SYSTEM_DISK:表示系统盘 | DATA_DISK:表示数据盘)
  • disk-charge-type - Array of String - 是否必填:否 -(过滤条件)按照云硬盘计费模式过滤。 (PREPAID:表示预付费,即包年包月 | POSTPAID_BY_HOUR:表示后付费,即按量计费。)
  • portable - Array of String - 是否必填:否 -(过滤条件)按是否为弹性云盘过滤。 (TRUE:表示弹性云盘 | FALSE:表示非弹性云盘。)
  • project-id - Array of Integer - 是否必填:否 -(过滤条件)按云硬盘所属项目ID过滤。
  • disk-id - Array of String - 是否必填:否 -(过滤条件)按照云硬盘ID过滤。云盘ID形如:disk-11112222
  • disk-name - Array of String - 是否必填:否 -(过滤条件)按照云盘名称过滤。
  • disk-type - Array of String - 是否必填:否 -(过滤条件)按照云盘介质类型过滤。(CLOUD_BASIC:表示普通云硬盘 | CLOUD_PREMIUM:表示高性能云硬盘。| CLOUD_SSD:表示SSD云硬盘 | CLOUD_HSSD:表示增强型SSD云硬盘。| CLOUD_TSSD:表示极速型云硬盘。)
  • disk-state - Array of String - 是否必填:否 -(过滤条件)按照云盘状态过滤。(UNATTACHED:未挂载 | ATTACHING:挂载中 | ATTACHED:已挂载 | DETACHING:解挂中 | EXPANDING:扩容中 | ROLLBACKING:回滚中 | TORECYCLE:待回收。)
  • instance-id - Array of String - 是否必填:否 -(过滤条件)按照云盘挂载的云主机实例ID过滤。可根据此参数查询挂载在指定云主机下的云硬盘。
  • zone - Array of String - 是否必填:否 -(过滤条件)按照可用区过滤。
  • instance-ip-address - Array of String - 是否必填:否 -(过滤条件)按云盘所挂载云主机的内网或外网IP过滤。
  • instance-name - Array of String - 是否必填:否 -(过滤条件)按云盘所挂载的实例名称过滤。
  • tag-key - Array of String - 是否必填:否 -(过滤条件)按照标签键进行过滤。
  • tag-value - Array of String - 是否必填:否 -(过滤条件)照标签值进行过滤。
  • tag:tag-key - Array of String - 是否必填:否 -(过滤条件)按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。
  • dedicated-cluster-id - Array of String - 是否必填:否 -(过滤条件)按照 CDC 独享集群 ID 进行过滤。
  • cluster-group-id - String - 是否必填:否 -(过滤条件)按照 集群群组 ID 进行过滤。
  • Limit Integer 返回数量,默认为20,最大值为100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。
    示例值:20
    OrderField String 云盘列表排序的依据字段。取值范围:
  • CREATE_TIME:依据云盘的创建时间排序
  • DEADLINE:依据云盘的到期时间排序
    默认按云盘创建时间排序。
    示例值:CREATE_TIME
  • Offset Integer 偏移量,默认为0。关于Offset的更进一步介绍请参考API简介中的相关小节。
    示例值:0
    ReturnBindAutoSnapshotPolicy Boolean 云盘详情中是否需要返回云盘绑定的定期快照策略ID,TRUE表示需要返回,FALSE表示不返回。
    示例值:FALSE
    DiskIds.N Array of String 按照一个或者多个云硬盘ID查询。云硬盘ID形如:disk-11112222,此参数的具体格式可参考API简介的ids.N一节)。参数不支持同时指定DiskIdsFilters
    示例值:["disk-xxxxxxxx"]
    Order String 输出云盘列表的排列顺序。取值范围:
  • ASC:升序排列
  • DESC:降序排列。
    示例值:ASC
  • 3. 输出参数

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

    4. 示例

    示例1 查询所有已挂载的数据盘

    用于查询所有已挂载的数据盘

    输入示例

    POST / HTTP/1.1
    Host: cbs.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeDisks
    <公共请求参数>
    
    {
        "Filters": [
            {
                "Values": [
                    "ATTACHED"
                ],
                "Name": "disk-state"
            },
            {
                "Values": [
                    "DATA_DISK"
                ],
                "Name": "disk-usage"
            }
        ]
    }

    输出示例

    {
        "Response": {
            "TotalCount": 1,
            "RequestId": "e2386a23-48c1-4c18-9a36-4e7354f333b2",
            "DiskSet": [
                {
                    "DeleteWithInstance": false,
                    "Encrypt": false,
                    "DiskType": "CLOUD_BASIC",
                    "AutoRenewFlagError": false,
                    "Rollbacking": false,
                    "RenewFlag": "NOTIFY_AND_MANUAL_RENEW",
                    "DiskName": "test",
                    "Tags": [],
                    "InstanceId": "",
                    "DifferDaysOfDeadline": 1,
                    "DiskId": "disk-b94t5dzt",
                    "DiskState": "ATTACHED",
                    "Placement": {
                        "ProjectId": 0,
                        "Zone": "ap-guangzhou-2"
                    },
                    "IsReturnable": false,
                    "DeadlineTime": "2018-10-26 10:55:43",
                    "Attached": true,
                    "DiskSize": 10,
                    "DiskUsage": "DATA_DISK",
                    "Portable": true,
                    "DiskChargeType": "PREPAID",
                    "SnapshotAbility": true,
                    "DeadlineError": false,
                    "RollbackPercent": 100,
                    "AutoSnapshotPolicyIds": null,
                    "ReturnFailCode": 3,
                    "CreateTime": "2018-09-26 17:36:07",
                    "ThroughputPerformance": 1,
                    "Migrating": true,
                    "InstanceIdList": [
                        "ins-test1234"
                    ],
                    "Shareable": true,
                    "MigratePercent": 100,
                    "SnapshotSize": 100,
                    "SnapshotCount": 0,
                    "BackupDisk": true,
                    "AttachMode": "PF",
                    "DiskBackupQuota": 1,
                    "DiskBackupCount": 1,
                    "DeleteSnapshot": 0,
                    "InstanceType": "CVM"
                }
            ]
        }
    }

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InvalidFilter 指定的Filter不被支持。
    InvalidParameterValue 参数取值错误。
    MissingParameter 缺少参数错误。
    UnsupportedOperation 操作不支持。