全部文档
当前文档
最近更新时间：2022-01-10 10:24:24
本接口用于获取某段时间内按一级目录为维度下消耗的带宽，单位bps
支持按指定的起止时间查询，两者需要同时指定
支持音视频点播域名、大文件下载域名，不支持图片小文件域名
仅支持单个域名查询
支持批量目录过滤查询，多个目录用逗号（半角）分隔
最多可获取最近62天内24小时跨度的数据
统计粒度：5分钟粒度；10分钟粒度；20分钟粒度；1小时粒度；4小时粒度；8小时粒度；1天粒度；以上粒度的带宽值均取该粒度时间段的带宽峰值，即每5分钟有效带宽值的最高带宽
时效性：5分钟延迟
统计方式：按照server IP归属来进行统计
接口性能：接口最大吞吐量为10000，即Region个数*Dir个数*(EndTime-StartTime)/统计粒度 <= 10000。注：在获取多个目录多个区域合并值时，Dir个数和Region个数按照1计算
支持统计域名下一级目录所产生的带宽，即请求URL中域名后的第一个“/”和第二个“/”之间的内容
当取不到一级目录时，即请求URL中域名后有且仅有一个“/时，将统计这部分请求URL产生的流量并进行求和，以“/”表示；
单次查询域名数量不得超过1000个，且单次查询时间跨度至少包含一个时间粒度点（如，粒度为5分钟的时候，单次查询起止时间应大于等于五分钟)。
使用场景：
注意：
本接口请求需要包含指定目录/2016-09-01/statistics/GetBandwidthDataByDir和公共请求header和该接口所特有的请求参数，具体请求语句参照下文请求示例。
| 参数名 | 必选 | 类型及范围 | 说明 |
|---|---|---|---|
| StartTime | 是 | String | 获取数据起始时间点，日期格式按ISO8601表示法，北京时间，格式为：YYYY-MM-DDThh:mm+0800，例如： 2016-08-01T21:14+0800 |
| EndTime | 是 | String | 结束时间需大于起始时间；获取日期格式按照ISO8601表示法，北京时间，格式为：YYYY-MM-DDThh:mm+0800，例如： 2016-08-01T21:14+0800 |
| DomainId | 是 | String | 输入需要查询的域名ID，只允许输入一个 |
| Dirs | 否 | String | 目录名称，支持统计域名下一级目录，即请求URL中域名后的第一个“/”和第二个“/”之间的内容(不包含/);支持批量查询，多个目录用逗号（半角）分隔，缺省为该域名下所有一级目录及“/”；若输入/，则查询该域名下所有一级目录的URL带宽合并值 |
| Regions | 否 | String | 区域名称，枚举类型表见使用须知，支持多区域查询，多个区域用逗号（半角）分隔，缺省为 CN缺省为 CN |
| ResultType | 是 | Int | 取值为0：多目录多区域数据做合并；1：每个目录每个区域的数据分别返回 |
| Granularity | 否 | Int | 统计粒度，取值为 5（默认）：5分钟粒度；10：10分钟粒度；20：20分钟粒度；60：1小时粒度；240：4小时粒度；480：8小时粒度；1440：1天粒度；以上粒度的带宽值均取该粒度时间段的带宽峰值，即每5分钟有效带宽值的最高带宽 |
| 参数 | 类型 | 描述 |
|---|---|---|
| StartTime | String | 开始时间 |
| EndTime | String | 结束时间 |
| DomainId | String | 域名ID |
| Dirs | String | 目录名称，无一级目录以“/”表示 |
| Regions | String | 区域，逗号（半角）间隔，枚举类型表见使用须知 |
| ResultType | Int | 取值为0：多目录多区域数据做合并返回；1：每个目录每个区域的数据分别返回 |
| Granularity | Int | 统计粒度，取值为 5：5分钟粒度；10：10分钟粒度；20：20分钟粒度；60：1小时粒度；240：4小时粒度；480：8小时粒度；1440：1天粒度；以上粒度的带宽值均取该粒度时间段的带宽峰值，即每5分钟有效带宽值的最高带宽 |
| Datas | BpsDataByTime[] | 每个时间粒度的带宽数据 |
| 参数 | 类型 | 描述 |
|---|---|---|
| Time | String | 时间点 |
| Bw | Long | 服务带宽（单位bps）（该域名下所选目录的服务带宽，若选择多个区域，则返回该域名下所选目录在多个区域的数据合并值） |
| Dirs | BpsDataByDir[] | 每个目录的详细带宽数据(仅当ResultType取值为1时返回此项数据) |
| 参数 | 类型 | 描述 |
|---|---|---|
| Dir | String | 目录名称 |
| Bw | Long | 服务带宽（单位bps）（该目录下的服务带宽，若选择多个区域，则返回该目录下多个区域的数据合并值） |
| Regions | BpsDataByRegion[] | 该目录在每个区域的详细带宽数据 |
| 参数 | 类型 | 描述 |
|---|---|---|
| Region | String | 区域名称 |
| Bw | Long | 服务带宽（单位bps）（该目录在该区域的服务带宽数据） |
请求示例：
GET方式：
GET /2016-09-01/statistics/GetBandwidthDataByDir?StartTime=2017-02-23T10%3a00%2b0800&EndTime=2017-02-23T10%3a21%2b0800&Regions&ResultType=1&granularity=10&DomainId=2D09NMS&Dirs=/ 1.1
Host: cdn.api.ksyun.com
X-Amz-Date: date
Authorization:authorization string
x-action: GetBandwidthDataByDir
x-version: 2016-09-01
POST方式：
POST /2016-09-01/statistics/GetBandwidthDataByDir 1.1
Host: cdn.api.ksyun.com
X-Amz-Date: date
Authorization:authorization string
x-action: GetBandwidthDataByDir
x-version: 2016-09-01
Content-Type: application/json
{
"StartTime":"2017-02-23T10:00+0800",
"EndTime":"2017-02-23T10:21+0800",
"Regions":"",
"ResultType":"1",
"granularity":"10",
"DomainId":"2D09NMS",
"Dirs":"/"
}
返回示例：
{
"StartTime": "2017-02-23T10:00+0800",
"EndTime": "2017-02-23T10:21+0800",
"DomainId": "2D09NMS",
"Regions": "CN",
"ResultType": 1,
"Dirs": "/",
"Granularity": 10,
"Datas": [
{
"Time": "2017-02-23T10:00+0800",
"Bw": 25771,
"Dirs": [
{
"Dir": "/",
"Bw": 25771,
"Regions": [
{
"Bw": 25771,
"Region": "CN"
}
]
}
]
},
{
"Time": "2017-02-23T10:10+0800",
"Bw": 24246,
"Dirs": [
{
"Dir": "/",
"Bw": 24246,
"Regions": [
{
"Bw": 24246,
"Region": "CN"
}
]
}
]
},
{
"Time": "2017-02-23T10:20+0800",
"Bw": 22529,
"Dirs": [
{
"Dir": "/",
"Bw": 22529,
"Regions": [
{
"Bw": 22529,
"Region": "CN"
}
]
}
]
}
]
}
纯净模式