查询块存储列表

最近更新时间: 2024-10-18 10:38:44

1. 接口描述

接口请求域名: cbs.api3.fincloud.tencent.cn。

本接口(DescribeBlockStorages)用于查询块存储列表。可以同时查询本地盘和云盘。

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

接口更新时间:2020-06-02 17:07:28。

接口只验签名不鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action String 公共参数,本接口取值:DescribeBlockStorages
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,详见产品支持的地域列表(TODO)
Limit Uint64 返回数量,默认为100,最大值为1000。关于Limit的更进一步介绍请参考 API 简介中的相关小节。
Offset Uint64 偏移量,默认为0。关于Offset的更进一步介绍请参考 API 简介中的相关小节。
DiskIds Array of String 按照一个或者多个云硬盘ID查询。
InnerSearch String 内部参数,用于支持搜索框搜索。

3. 输出参数

参数名称 类型 描述
TotalCount Uint64 此参数对外不可见。
符合条件的块存储数量。
DiskSet BlockStorage 此参数对外不可见。
块存储详细信息列表。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码 描述
InvalidParameterValue