# DescribeRankingBandwidth

## 1. 接口描述

本接口(DescribeRankingBandwidth)用于查询cdn访问带宽排行，最多显示100个域名。

## 2. 请求参数

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

| 参数名称      | 必选 | 类型     | 描述                                                                                                      |
| --------- | -- | ------ | ------------------------------------------------------------------------------------------------------- |
| startTime | 是  | String | 获取数据起始时间点。日期格式按照 ISO8601 表示法，并使用 UTC 时间，格式为 yyyy-MM-ddTHH:mm:ssZ，例如2024-08-21T00:00:00Z                 |
| endTime   | 是  | String | 获取数据结束时间点。日期格式按照 ISO8601 表示法，并使用 UTC 时间，格式为 yyyy-MM-ddTHH:mm:ssZ，例如2024-08-21T01:00:00Z。结束时间点需要大于起始时间点。 |

## 3. 响应结果

| 参数名称      | 类型                                                                                                                              | 描述                                         |
| --------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------ |
| dataSet   | Array of [RankingBandwithData](https://docs.console.zenlayer.com/api-reference/cn/networking/datastructure#rankingbandwithdata) | 带宽排行。                                      |
| requestId | String                                                                                                                          | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 requestId。 |

## 4. 代码示例

{% tabs %}
{% tab title="示例" %}

1. **查询cdn访问带宽排行。**

```json
POST / HTTP/1.1
Host: console.zenlayer.com/api/v2/cdn
Content-Type: application/json
X-TC-Action: DescribeRankingBandwidth
<Common Request Params>

Request:
{
    "startTime": "2022-09-21T02:00:00Z",
    "endTime": "2022-09-21T03:30:00Z"
}

Response:
{
    "requestId": "T6883FCD0-3E7D-44EA-A517-A421A52A27F4",
    "response": {
        "requestId": "T6883FCD0-3E7D-44EA-A517-A421A52A27F4",
        "dataSet": [{
            "maxbandwidth": 8.98,
            "domain": "testcdn.ddd520.com",
            "requests": 250,
            "time": "2022-09-21T03:25:00Z",
            "traffic": 415.34
        }, {
            "maxbandwidth": 2.1,
            "domain": "*.ddd520.com",
            "requests": 8,
            "time": "2022-09-21T02:10:00Z",
            "traffic": 21.19
        }]
    }
}
```

{% endtab %}
{% endtabs %}

## 5. 错误码

下面包含业务逻辑中遇到的错误码，其他错误码见[公共错误码](https://docs.console.zenlayer.com/api-reference/cn/api-introduction/instruction/commonerrorcode)
