查询云硬盘列表

最近更新时间:2018-07-27 21:02:17

1. 接口描述

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

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

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

接口请求频率限制:20次/每秒

注意:本接口支持金融区地域。公共参数 Region 为金融区地域时,需要同时指定带金融区地域的域名,例如:cbs.ap-shanghai-fsi.tencentcloudapi.com

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDisks
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,详见产品支持的地域列表
DiskIds.N Array of String 按照一个或者多个云硬盘ID查询。云硬盘ID形如:disk-11112222,此参数的具体格式可参考API简介的ids.N一节)。参数不支持同时指定DiskIdsFilters
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表示SSD云硬盘。)
  • 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 - Array of Tag - 是否必填:否 -(过滤条件)按云盘绑定的标签过滤。
  • Offset Integer 偏移量,默认为0。关于Offset的更进一步介绍请参考API简介中的相关小节。
    Limit Integer 返回数量,默认为20,最大值为100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。
    Order String 输出云盘列表的排列顺序。取值范围:
  • ASC:升序排列
  • DESC:降序排列。
  • OrderField String 云盘列表排序的依据字段。取值范围:
  • CREATE_TIME:依据云盘的创建时间排序
  • DEADLINE:依据云盘的到期时间排序
    默认按云盘创建时间排序。
  • ReturnBindAutoSnapshotPolicy Boolean 云盘详情中是否需要返回云盘绑定的定期快照策略ID,TRUE表示需要返回,FALSE表示不返回。

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 符合条件的云硬盘数量。
    DiskSet Array of Disk 云硬盘的详细信息列表。
    RequestId String 唯一请求ID,每次请求都会返回。定位问题时需要提供该次请求的RequestId。

    4. 错误码

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

    错误码 描述
    InvalidFilter 指定的Filter不被支持。
    InvalidParameterValue 无效参数值。参数值格式错误或者参数值不被支持等。
    MissingParameter 参数缺失。请求没有带必选参数。

    5. 示例

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

    输入示例

    https://cbs.tencentcloudapi.com/?Action=DescribeDisks
    &Filters.0.Name=disk-usage
    &Filters.0.Values.0=DATA_DISK
    &Filters.1.Name=disk-state
    &Filters.1.Values.0=ATTACHED
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "DiskSet": [
          {
            "Attached": true,
            "AutoRenewFlagError": false,
            "CreateTime": "2017-07-27 15:16:56",
            "DeadlineError": false,
            "DeadlineTime": "2017-10-27 15:17:05",
            "DifferDaysOfDeadline": -139,
            "DiskChargeType": "PREPAID",
            "DiskId": "disk-5w50lrms",
            "DiskName": "data1",
            "DiskSize": 10,
            "DiskState": "ATTACHED",
            "DiskType": "CLOUD_BASIC",
            "DiskUsage": "DATA_DISK",
            "Encrypt": false,
            "InstanceId": "ins-6p8zngem",
            "IsReturnable": false,
            "Placement": {
              "ProjectId": 10086,
              "Zone": "ap-guangzhou-2"
            },
            "Portable": true,
            "RenewFlag": "NOTIFY_AND_AUTO_RENEW",
            "ReturnFailCode": 2,
            "RollbackPercent": 0,
            "Rollbacking": false,
            "SnapshotAbility": true
          }
        ],
        "RequestId": "e63c7075-4b34-4825-9850-b19edb1eda89",
        "TotalCount": 1
      }
    }

    6. 其他资源

    云 API 3.0 提供了配套的开发工具,能更方便的调用 API 。