DescribeBandwidthClusterUsage

1. 接口描述

本接口(DescribeBandwidthClusterUsage)用于查询共享带宽包的用量信息。

2. 请求参数

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

参数名称	必选	类型	描述
bandwidthClusterId	是	String	共享带宽包ID。
pageSize	否	Integer	返回的分页大小。 默认为20。
pageNum	否	Integer	返回的分页数。 默认值：1

3. 响应结果

参数名称	类型	描述
requestId	String	唯一请求 ID。 每次请求都会返回。定位问题时需要提供该次请求的 requestId。
totalCount	Integer	符合条件的数据总数。 默认值：0
dataSet	Array of BandwidthClusterUsageData	带宽用量数据集。 默认值：[]

4. 代码示例

示例

1. 查询共享带宽包的用量信息。

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

Request：
{
  "bandwidthClusterId": "bandwidthClusterId",
  "pageNum": 1,
  "pageSize": 20
}

Response：
{
  "requestId": "T4C35327C-7B13-47B8-A815-5E5213D4A9F9",
  "response": {
    "requestId": "T4C35327C-7B13-47B8-A815-5E5213D4A9F9",
    "totalCount": 30,
    "dataSet": [
      {
        "time": "2024-01-01",
        "value": 100.50,
        "details": [
          {
            "cityName": "Los Angeles",
            "cityCode": "LAX",
            "product": "BMC",
            "value": 50.25
          },
          {
            "cityName": "Singapore",
            "cityCode": "SIN",
            "product": "BMC",
            "value": 50.25
          }
        ]
      },
      {
        "time": "2024-01-02",
        "value": 120.80,
        "details": [
          {
            "cityName": "Los Angeles",
            "cityCode": "LAX",
            "product": "BMC",
            "value": 60.40
          },
          {
            "cityName": "Singapore",
            "cityCode": "SIN",
            "product": "BMC",
            "value": 60.40
          }
        ]
      }
    ]
  }
}

5. 开发者工具

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

6. 错误码

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

HTTP状态码	错误码	说明
404	INVALID_CLUSTER_NOT_FOUND	指定的带宽组不存在。