CDN

查询目录流量

最近更新时间:2018-12-17 16:03:50

GetFlowDataByDir

描述

本接口用于获取某段时间内按一级目录为维度下消耗的流量,单位byte

  • 支持按指定的起止时间查询,两者需要同时指定
  • 仅支持下载域名查询
  • 仅支持单个域名查询
  • 支持批量目录过滤查询,多个目录用逗号(半角)分隔,默认为全选
  • 最多可获取最近62天内24小时跨度的数据
  • 统计粒度:5分钟粒度;10分钟粒度;20分钟粒度;1小时粒度;4小时粒度;8小时粒度;1天粒度;以上粒度流量值均取该粒度时间段的流量总和
  • 时效性:5分钟延迟
  • 接口性能:接口最大吞吐量为10000,即Region个数*Dir个数*(EndTime-StartTime)\统计粒度 <= 10000。注:在获取多个目录多个区域合并值时,Dir个数和Region个数按照1计算
  • 支持统计域名下一级目录所产生的流量,即请求URL中域名后的第一个“/”和第二个“/”之间的内容
  • 当取不到一级目录时,即请求URL中域名后有且仅有一个“/”时,将统计这部分请求URL产生的流量并进行求和,以“/”表示;
  • 使用场景:
    • 客户查询一个域名下单个或多个目录的流量数据汇总,以单独查看或对比同一域名下不同目录的流量曲线
  • 注意
    • 需配置白名单后方可正确返回目录带宽数据,请线下联系您的技术支持人员进行配置

请求语法

本接口请求需要包含指定目录/2016-09-01/statistics/GetFlowDataByDir和公共请求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:中国大陆,HK:香港,TW:台湾,AS:亚洲其他,NA:北美洲,SA:南美洲,EU:欧洲,AU:大洋洲,AF:非洲,支持多区域查询,多个区域用逗号(半角)分隔,缺省为 CN
ResultType Int 取值为0:多目录多区域数据做合并;1:每个目录每个区域的数据分别返回
Granularity Int 统计粒度,取值为 5(默认):5分钟粒度;10:10分钟粒度;20:20分钟粒度;60:1小时粒度;240:4小时粒度;480:8小时粒度;1440:1天粒度;以上粒度流量值均取该粒度时间段的流量总和

返回参数

参数 类型 描述
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天粒度;以上粒度流量值均取该粒度时间段的流量总和
Datas FlowDataByTime[] 每个时间粒度的流量数据

FlowDataByTime

参数 类型 描述
Time String 时间点
Flow Long 边缘流量(该域名下所选目录的边缘流量,若选择多个区域,则返回该域名下所选目录在多个区域的数据合并值)
Dirs FlowDataByDir[] 每个目录的详细流量数据(仅当ResultType取值为1时返回此项数据)

FlowDataByDir

参数 类型 描述
Dir String 目录名称
Flow Long 边缘流量(该目录下的边缘流量,若选择多个区域,则返回该目录下多个区域的数据合并值)
Regions FlowDataByRegion[] 该目录在每个区域的详细流量数据

FlowDataByRegion

参数 类型 描述
Region String 区域名称
Flow Long 边缘流量(该目录在该区域的边缘流量数据)

示例

请求示例

GET方式:

GET /2016-09-01/statistics/GetFlowDataByDir?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: GetFlowDataByDir
x-version: 2016-09-01

POST方式:

POST /2016-09-01/statistics/GetFlowDataByDir 1.1
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",
      "Flow": 1893182,
      "Dirs": [
        {
          "Dir": "/",
          "Flow": 1893182,
          "Regions": [
            {
              "Flow": 1893182,
              "Region": "CN"
            }
          ]
        }
      ]
    },
    {
      "Time": "2017-02-23T10:10+0800",
      "Flow": 1802091,
      "Dirs": [
        {
          "Dir": "/",
          "Flow": 1802091,
          "Regions": [
            {
              "Flow": 1802091,
              "Region": "CN"
            }
          ]
        }
      ]
    },
    {
      "Time": "2017-02-23T10:20+0800",
      "Flow": 844868,
      "Dirs": [
        {
          "Dir": "/",
          "Flow": 844868,
          "Regions": [
            {
              "Flow": 844868,
              "Region": "CN"
            }
          ]
        }
      ]
    }
  ]
}

金山云,开启您的云计算之旅

立即注册