查询BMS硬盘列表
最近更新时间: 2024-06-18 14:31:22
1. 接口描述
接口请求域名： bms.api3.fincloud.tencent.cn。
本接口（DescribeDisks）用于查询BMS硬盘列表。
- 可以根据BMS硬盘ID等信息来查询BMS硬盘的详细信息，不同条件之间为与(AND)的关系，过滤信息详细请见过滤器
Filter。 - 如果参数为空，返回当前用户一定数量（
Limit所指定的数量，默认为20）的BMS硬盘列表。
默认接口请求频率限制：20次/秒。
接口更新时间：2021-04-28 19:00:30。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeDisks |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-08-13 |
| Region | 是 | 否 | String | 公共参数，详见产品支持的地域列表(TODO) |
| DiskIds | 否 | 否 | Array of String | 按照一个或者多个硬盘ID查询。硬盘ID形如：disk-11112222。参数不支持同时指定DiskIds和Filters。 |
| Filters | 否 | 否 | Array of Filter | 过滤条件。参数不支持同时指定DiskIds和Filters。<br><li>disk-id - Array of String - 是否必填：否 -（过滤条件）按照硬盘ID过滤。硬盘ID形如：disk-11112222<br><li>instance-id - Array of String - 是否必填：否 -（过滤条件）按照硬盘挂载的裸金属实例ID过滤。可根据此参数查询挂载在指定机下的硬盘。<br><li>zone - Array of String - 是否必填：否 -（过滤条件） |
| Offset | 否 | 否 | Uint64 | 偏移量，默认为0。 |
| Limit | 否 | 否 | Uint64 | 返回数量，默认为20，最大值为100。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Uint64 | 此参数对外不可见。 符合条件的硬盘数量。 |
| DiskSet | Disk | 此参数对外不可见。 硬盘的详细信息列表。 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
该接口暂无业务逻辑相关的错误码，其他错误码详见公共错误码。