API 中心
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > API 中心 > 云硬盘 > 云硬盘相关接口 > 查询云硬盘独享集群列表

查询云硬盘独享集群列表

最近更新时间：2024-03-12 01:12:41

我的收藏

本页目录：

1. 接口描述

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

本接口（DescribeDiskStoragePool）查询用户的云硬盘独享集群列表。

  • 可以根据独享集群ID(CdcId)、可用区(zone)等信息来查询和过滤云硬盘独享集群详细信息，不同的过滤条件之间为与(AND)的关系，过滤信息详细请见过滤器Filter。
  • 如果参数为空，返回当前用户一定数量（Limit所指定的数量，默认为20）的云硬盘独享集群列表。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeDiskStoragePool。
Version 是 String 公共参数，本接口取值：2017-03-12。
Region 是 String 公共参数，详见产品支持的 地域列表。
Limit 否 Integer 返回数量，默认为20，最大值为100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。
示例值：20
CdcIds.N 否 Array of String 指定需要查询的独享集群ID列表，该入参不能与Filters一起使用。
示例值：cdc-asdasd
Filters.N 否 Array of Filter 过滤条件。参数不支持同时指定CdcIds和Filters。
  • cdc-id - Array of String - 是否必填：否 -（过滤条件）按独享集群ID过滤。
  • zone - Array of String - 是否必填：否 -（过滤条件）按独享集群所在可用区过滤。
  • cage-id - Array of String - 是否必填：否 -（过滤条件）按独享集群所在围笼的ID过滤。
  • disk-type - Array of String - 是否必填：否 -（过滤条件）按照云盘介质类型过滤。(CLOUD_BASIC：表示普通云硬盘 | CLOUD_PREMIUM：表示高性能云硬盘。| CLOUD_SSD：SSD表示SSD云硬盘。)
    		•
    Offset 否 Integer 偏移量，默认为0。关于Offset的更进一步介绍请参考API简介中的相关小节。
    示例值：0

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 符合条件的独享集群的数量
    示例值：1
    CdcSet Array of Cdc 独享集群的详细信息列表
    DiskStoragePoolSet Array of Cdc 独享集群的详细信息列表
    RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 指定独享集群ID查询集群详情。

    部分用户(金融)对cbs集群有独享需求，该接口用来查询用户所拥有的独享集群。

    输入示例

    POST / HTTP/1.1
Host: cbs.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDiskStoragePool
<公共请求参数>

{
    "Filters": [
        {
            "Name": "cdc-id",
            "Values": [
                "cdc-6brr1cvj"
            ]
        }
    ]
}

    输出示例

    {
    "Response": {
        "TotalCount": 1,
        "RequestId": "2ed78bbb-c62b-4a93-8a97-a614ed9ef7e0",
        "DiskStoragePoolSet": [],
        "CdcSet": [
            {
                "CageId": "cdc-6brr1cvj",
                "CdcState": "NORMAL",
                "Zone": "ap-chongqing-1",
                "CdcName": "untitled",
                "CdcResource": {
                    "DiskTotal": 10
                },
                "CdcId": "cdc-xxx",
                "DiskType": "CLOUD_SSD",
                "DiskNumber": 135,
                "ExpiredTime": "2022-02-25 15:59:15",
                "CreatedTime": "2022-01-25T15:59:15+00:00"
            }
        ]
    }
}

    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不被支持。
    InvalidParameter 参数错误。
    MissingParameter 缺少参数错误。
    中国站