DescribeBandwidthClusters

1. 接口描述

调用本接口用于查询一个或多个带宽组的信息。用户可以根据带宽组ID、带宽组名称或者带宽组城市名称等条件来查询带宽组的详细信息。

2. 请求参数

以下请求参数列表仅列出了接口中需要的请求参数

参数名称	必选	类型	描述
bandwidthClusterIds	否	Array of String	带宽组ID。 最多支持100个ID查询。
bandwidthClusterName	否	String	带宽组显示名称。支持模糊匹配。
cityName	否	String	带宽组所包含的城市名称。
pageSize	否	Integer	返回的分页大小。 默认为20，最大为1000。
pageNum	否	Integer	返回的分页数。 默认为1。

3. 响应结果

参数名称	类型	描述
requestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 requestId。
totalCount	Integer	符合条件的数据总数。
dataSet	Array of BandwidthClusterInfo	结果集。

4. 代码示例

示例

1. 分页查询带宽组列表

POST /api/v2/traffic HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: DescribeBandwidthClusters
<Common Request Params>

Request:
{
  "pageNum": 1,
  "pageSize": 1
}

Response:
{
    "requestId": "TEEFDCA5B-76FB-4E91-A18E-DF7F5D2CE41F",
    "response": {
        "requestId": "TEEFDCA5B-76FB-4E91-A18E-DF7F5D2CE41F",
        "totalCount": 1,
        "dataSet": [
            {
                "bandwidthClusterId": "bandwidthClusterId",
                "bandwidthClusterName": "Frankfurt",
                "location": "Frankfurt",
                "createTime": "2024-01-01T00:00:00Z"
            }
        ]
    }
}

5. 开发者工具

Zenlayer Cloud API 2.0 提供了配套的开发工具集（SDK），未来会陆续支持更多开发语言，方便快速接入和使用Zenlayer的产品和服务。

6. 错误码

下面包含业务逻辑中遇到的错误码，其他错误码见公共错误码