DescribeDisks

最近更新时间: 2024-12-21 13:01:31

1. 接口描述

接口请求域名: cbs.api3.gsesgpucloud.com。

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

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

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

接口更新时间:2024-08-14 00:50:33。

接口只验签名不鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action String 公共参数,本接口取值:DescribeDisks
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表
DiskIds Array of String 按照一个或者多个云硬盘ID查询。云硬盘ID形如:disk-11112222,参数不支持同时指定DiskIdsFilters
示例值:
Filters Array of Filter 过滤条件。参数不支持同时指定DiskIdsFilters
  • disk-usage - Array of String - 是否必填:否 -(过滤条件)按云盘类型过滤。 (SYSTEM_DISK:表示系统盘 
  • Offset Uint64 偏移量,默认为0。
    示例值:
    Limit Uint64 返回数量,默认为20,最大值为100。
    示例值:
    Order String 输出云盘列表的排列顺序。取值范围:
  • ASC:升序排列
  • DESC:降序排列。
    示例值:
  • OrderField String 云盘列表排序的依据字段。取值范围:
  • CREATE_TIME:依据云盘的创建时间排序
  • DEADLINE:依据云盘的到期时间排序
    默认按云盘创建时间排序。
    示例值:
  • ReturnBindAutoSnapshotPolicy Bool 云盘详情中是否需要返回云盘绑定的定期快照策略ID,TRUE表示需要返回,FALSE表示不返回。
    示例值:
    InnerSearch String 内部参数,用于支持搜索框搜索。
    示例值:

    3. 输出参数

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

    4. 错误码

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

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