通用获取流量接口

请求地址

https://api.upyun.com/flow/common_data/

请求方式

GET

是否需要登陆授权

是,关于登录授权,参见授权机制

请求参数 (说明列的括号中表示可取的值或者可取的格式)

必选 数据类型及范围 说明
start_time true string 统计数据起始时间(2016-04-10 22:23:00)
end_time true string 统计数据截止时间(2016-04-12 22:23:00)
query_type false string 查询的数据类型(服务名:bucket ; 域名: domain)
query_value false string 数据查询的值
region false string 查询某个地区的数据(北京 , 天津 , 河北 , 山西 , 内蒙古, 辽宁 , 吉林 , 黑龙江, 上海 , 江苏 , 浙江 , 安徽 , 福建 , 江西 , 山东 , 河南 , 湖北 , 湖南 , 广东 , 广西 , 海南 , 重庆 , 四川 , 贵州 , 云南 , 西藏 , 陕西 , 甘肃 , 青海 , 宁夏 , 新疆 , 香港 , 澳门 , 台湾) (ex: region=浙江)
isp false string 查询某个运营商的数据(电信(ctn) 移动(cmn) 联通(cun) 铁通(ttn) 教育网(edun) 科技网(sat) 鹏博士(drp) 浙江华数(wasu) 广电(ratn) 歌华有线(bgctv) 方正宽带(bnc) 其他) (不传就是查询全部) (ex: isp=ctn)
sum_data false boolean 是否计算多运营商多区域查询时返回统计数据(不区分省份以及)
full_region_isp false boolean 是否需要在结果中返回所有区域所有运营上的统计数据 例子
flow_type false string 指定流量类型 可取值:(cdn: cdn流量数据; live: 直播流量数据), 默认cdn
live_type false string 指定直播流量类型 可取值:(up: 上行流量数据, down: 下行流量数据), 默认 down,下行流量
flow_source false string 指定获取数据源 可取值:(cdn: 获取外围节点数据, backsource: 获取回源流量数据), 默认cdn
fields false string 在查询cdn的基础数据时,指定返回字段(httpcode, bytes,reqs,time,cc,inj,lreqs,ltime,lbytes,extwaf,hreqs,hbytes,dreqs,dbytes,hit_bytes,xss,hit,_200,_206,_301,_302,_304,_400,_403,_404,_411,_499,_500,_502,_503,_504), 多个字段使用逗号隔开. 值httpcode表示返回所有的http状态码

查询方式说明

基础数据查询

   1.查询当前帐号

   2.查询空间流量

   3.查询域名流量

   4.基础数据返回结果

查询地区相关数据以及查询详细数据

   1. 查询所有地区所有运营商的统计数据(包括状态码,命中数,攻击数等数据)

   2.查询单个地区/单个运营运营商/或者是组合查询某个地区某个运营商(包括状态码,命中数,攻击数等数据)

   3.详细数据查询返回结果

   4.查询多区域多运营商组合

   5.多区域数多运营商数据查询总和数据

   6.多区域数多运营商数据查询详细数据返回结果

   7.重要说明!

直播流量查询

   1.查询上行流量

   2.查询下行流量

   3.流量查询说明

   4.返回结果

查询回源流量

   1.查询参数

   2.返回结果

查询基础数据

  • 查询当前帐号
    {
      start_time: '2015-10-01 00:00:00',
      end_time: '2015-10-05 12:00:00',
    }
    
  • 查询空间流量
    {
      start_time: '2015-10-01 00:00:00',
      end_time: '2015-10-05 12:00:00',
      query_type: 'bucket',
      query_value: 'test_bucket_name'
    }
    
  • 查询域名流量
    {
      start_time: '2015-10-01 00:00:00',
      end_time: '2015-10-05 12:00:00',
      query_type: 'domain',
      query_value: 'test.example.com'
    }
    

基础数据返回结果

[ { reqs: 808088,
    bytes: 34136887004,
    hreqs: 0,
    dreqs: 0,
    time: 1433091900,
    bandwidth: 1055967704,
    rps: '2693.63' },
  { reqs: 766198,
    bytes: 32726050855,
    hreqs: 0,
    dreqs: 0,
    time: 1433092200,
    bandwidth: 1012325839,
    rps: '2553.99' },
  { reqs: 706787,
    bytes: 31139043732,
    hreqs: 0,
    dreqs: 0,
    time: 1433092500,
    bandwidth: 963234419,
    rps: '2355.96' },
  { reqs: 682634,
    bytes: 28177275481,
    hreqs: 0,
    dreqs: 0,
    time: 1433092800,
    bandwidth: 871617054,
    rps: '2275.45' },
  { reqs: 662230,
    bytes: 28423691838,
    hreqs: 0,
    dreqs: 0,
    time: 1433093100,
    bandwidth: 879239534,
    rps: '2207.43' },
  { reqs: 599160,
    bytes: 26257984070,
    hreqs: 0,
    dreqs: 0,
    time: 1433093400,
    bandwidth: 812246973,
    rps: '1997.20' }]
结果参数说明
字段 说明
reqs 请求总量
bytes 流量
hreqs https请求量
dreqs 动态请求量
time 当前数据统计时间
bandwidth 带宽
rps 每秒请求次数

NOTE:

此查询方式不支持返回状态码以及其他额外的数据

每条返回数据是当前时间戳往回5分钟的数据,例:时间戳如果是1433093400,则此数据表示01:25:00 - 01:30:00的数据.此接口所有数据都按照此规则返回


查询地区相关数据以及详细数据

  • 查询所有地区所有运营商的统计数据(包括状态码,命中数,攻击数等数据)

    {
      start_time: '2015-10-01 00:00:00',
      end_time: '2015-10-05 12:00:00',
      full_region_isp: true
    }
    
  • 查询单个地区/单个运营运营商/或者是组合查询某个地区某个运营商(包括状态码,命中数,攻击数等数据)

    {
      start_time: '2015-10-01 00:00:00',
      end_time: '2015-10-05 12:00:00',
      region: '浙江',
      isp: 'ctn'
    }
    

详细数据查询返回结果 (参数说明)

[ { rps: 0,
    nhit: 0,
    bandwidth: 0,
    bytes: 0,
    reqs: 0,
    time: 0,
    cc: 0,
    inj: 0,
    lreqs: 0,
    ltime: 0,
    lbytes: 0,
    hreqs: 0,
    hbytes:0,
    dreqs:0,
    dbytes:0,
    extwaf: 0,
    hit_bytes: 0,
    xss: 0,
    hit: 0,
    _200: 0,
    _206: 0,
    _301: 0,
    _302: 0,
    _304: 0,
    _400: 0,
    _403: 0,
    _404: 0,
    _411: 0,
    _499: 0,
    _500: 0,
    _502: 0,
    _503: 0,
    _504: 0,
    kt: 1433264700,
    kts: '2015-06-03 01:05:00' },
  { rps: 0,
    nhit: 0,
    bandwidth: 0,
    bytes: 0,
    reqs: 0,
    time: 0,
    cc: 0,
    inj: 0,
    lreqs: 0,
    ltime: 0,
    lbytes: 0,
    hreqs: 0,
    hbytes:0,
    dreqs:0,
    dbytes:0,
    extwaf: 0,
    hit_bytes: 0,
    xss: 0,
    hit: 0,
    _200: 0,
    _206: 0,
    _301: 0,
    _302: 0,
    _304: 0,
    _400: 0,
    _403: 0,
    _404: 0,
    _411: 0,
    _499: 0,
    _500: 0,
    _502: 0,
    _503: 0,
    _504: 0,
    kt: 1433265000,
    kts: '2015-06-03 01:10:00' } ]
NOTE:
  1. 以上是查询帐号相关数据,假如需要查询域名或者是服务,请参照查询基本数据请求参数,带上query_type以及query_value

  2. 以上两种查询方式不能只能返回一个总和数据,按照5分钟分时,如果需要查询多区域以及多运营商组合请使用查询多区域与多运营商组合


  • 查询多区域多运营商组合
    {
      start_time: '2015-10-01 00:00:00',
      end_time: '2015-10-05 12:00:00',
      region: '浙江,江苏',
      isp: 'ctn,cun'
    }
    
    NOTE: 逗号请使用英文字符

重要说明:

为了加快查询结果返回,在查询的时候,如果不需要返回地区运营商以及http code等信息,请使用基础查询。当使用full_region_isp返回结果按照运营商以及地区数据区分时,如果数据量特别大时响应会不及时,假如不需要返回地区以及运营商字段,可以加上sum_data字段来合并数据,假如必须返回时,此时可以使用fields来指定必须返回的字段来减少返回结果的大小加快查询速度

例子:

  • 查询所有地区运营商数据,只返回流量,使用基础数据查询 start_time=xxx&end_time=xxx 不需要添加其他参数
  • 查询所有地区所有运营商数据包含http code 以及其他的数据,必须返回运营商以及地区字段 start_time=xxx&end_time=xxx&full_region_isp=true
  • 查询所有地区所有运营商数据只需要包含http code以及大文件请求数,必须返回运营商以及地区字段 start_time=xxx&end_time=xxx&full_region_isp=true&fields=httpcode,lreqs
  • 查询所有地区所有运营商数据,包含http code 以及出去流量之外的其他额外信息,但是不需要返回地区运营商 start_time=xxx&end_time=xxx&full_region_isp=true&sum_data=true

多区域数多运营商数据查询详细数据返回结果 (详细参数说明)

{ '电信':
   { '浙江':
      [ { rps: 0,
          nhit: 0,
          bandwidth: 0,
          bytes: 0,
          reqs: 0,
          time: 0,
          cc: 0,
          inj: 0,
          lreqs: 0,
          ltime: 0,
          lbytes: 0,
          hreqs: 0,
          hbytes:0,
          dreqs:0,
          dbytes:0,
          extwaf: 0,
          hit_bytes: 0,
          xss: 0,
          hit: 0,
          _200: 0,
          _206: 0,
          _301: 0,
          _302: 0,
          _304: 0,
          _400: 0,
          _403: 0,
          _404: 0,
          _411: 0,
          _499: 0,
          _500: 0,
          _502: 0,
          _503: 0,
          _504: 0,
          kt: 1433264700,
          kts: '2015-06-03 01:05:00' },
        { rps: 0,
          nhit: 0,
          bandwidth: 0,
          bytes: 0,
          reqs: 0,
          time: 0,
          cc: 0,
          inj: 0,
          lreqs: 0,
          ltime: 0,
          lbytes: 0,
          hreqs: 0,
          hbytes:0,
          dreqs:0,
          dbytes:0,
          extwaf: 0,
          hit_bytes: 0,
          xss: 0,
          hit: 0,
          _200: 0,
          _206: 0,
          _301: 0,
          _302: 0,
          _304: 0,
          _400: 0,
          _403: 0,
          _404: 0,
          _411: 0,
          _499: 0,
          _500: 0,
          _502: 0,
          _503: 0,
          _504: 0,
          kt: 1433265000,
          kts: '2015-06-03 01:10:00' },
        [length]: 2 ],
     '江苏':
      [ { rps: 0,
          nhit: 0,
          bandwidth: 0,
          bytes: 0,
          reqs: 0,
          time: 0,
          cc: 0,
          inj: 0,
          lreqs: 0,
          ltime: 0,
          lbytes: 0,
          hreqs: 0,
          hbytes:0,
          dreqs:0,
          dbytes:0,
          extwaf: 0,
          hit_bytes: 0,
          xss: 0,
          hit: 0,
          _200: 0,
          _206: 0,
          _301: 0,
          _302: 0,
          _304: 0,
          _400: 0,
          _403: 0,
          _404: 0,
          _411: 0,
          _499: 0,
          _500: 0,
          _502: 0,
          _503: 0,
          _504: 0,
          kt: 1433264700,
          kts: '2015-06-03 01:05:00' },
        { rps: 0,
          nhit: 0,
          bandwidth: 0,
          bytes: 0,
          reqs: 0,
          time: 0,
          cc: 0,
          inj: 0,
          lreqs: 0,
          ltime: 0,
          lbytes: 0,
          hreqs: 0,
          hbytes:0,
          dreqs:0,
          dbytes:0,
          extwaf: 0,
          hit_bytes: 0,
          xss: 0,
          hit: 0,
          _200: 0,
          _206: 0,
          _301: 0,
          _302: 0,
          _304: 0,
          _400: 0,
          _403: 0,
          _404: 0,
          _411: 0,
          _499: 0,
          _500: 0,
          _502: 0,
          _503: 0,
          _504: 0,
          kt: 1433265000,
          kts: '2015-06-03 01:10:00' },
        [length]: 2 ] },
  '联通':
   { '浙江':
      [ { rps: 0,
          nhit: 0,
          bandwidth: 0,
          bytes: 0,
          reqs: 0,
          time: 0,
          cc: 0,
          inj: 0,
          lreqs: 0,
          ltime: 0,
          lbytes: 0,
          hreqs: 0,
          hbytes:0,
          dreqs:0,
          dbytes:0,
          extwaf: 0,
          hit_bytes: 0,
          xss: 0,
          hit: 0,
          _200: 0,
          _206: 0,
          _301: 0,
          _302: 0,
          _304: 0,
          _400: 0,
          _403: 0,
          _404: 0,
          _411: 0,
          _499: 0,
          _500: 0,
          _502: 0,
          _503: 0,
          _504: 0,
          kt: 1433264700,
          kts: '2015-06-03 01:05:00' },
        { rps: 0,
          nhit: 0,
          bandwidth: 0,
          bytes: 0,
          reqs: 0,
          time: 0,
          cc: 0,
          inj: 0,
          lreqs: 0,
          ltime: 0,
          lbytes: 0,
          hreqs: 0,
          hbytes:0,
          dreqs:0,
          dbytes:0,
          extwaf: 0,
          hit_bytes: 0,
          xss: 0,
          hit: 0,
          _200: 0,
          _206: 0,
          _301: 0,
          _302: 0,
          _304: 0,
          _400: 0,
          _403: 0,
          _404: 0,
          _411: 0,
          _499: 0,
          _500: 0,
          _502: 0,
          _503: 0,
          _504: 0,
          kt: 1433265000,
          kts: '2015-06-03 01:10:00' },
        [length]: 2 ],
     '江苏':
      [ { rps: 0,
          nhit: 0,
          bandwidth: 0,
          bytes: 0,
          reqs: 0,
          time: 0,
          cc: 0,
          inj: 0,
          lreqs: 0,
          ltime: 0,
          lbytes: 0,
          hreqs: 0,
          hbytes:0,
          dreqs:0,
          dbytes:0,
          extwaf: 0,
          hit_bytes: 0,
          xss: 0,
          hit: 0,
          _200: 0,
          _206: 0,
          _301: 0,
          _302: 0,
          _304: 0,
          _400: 0,
          _403: 0,
          _404: 0,
          _411: 0,
          _499: 0,
          _500: 0,
          _502: 0,
          _503: 0,
          _504: 0,
          kt: 1433264700,
          kts: '2015-06-03 01:05:00' },
        { rps: 0,
          nhit: 0,
          bandwidth: 0,
          bytes: 0,
          reqs: 0,
          time: 0,
          cc: 0,
          inj: 0,
          lreqs: 0,
          ltime: 0,
          lbytes: 0,
          hreqs: 0,
          hbytes:0,
          dreqs:0,
          dbytes:0,
          extwaf: 0,
          hit_bytes: 0,
          xss: 0,
          hit: 0,
          _200: 0,
          _206: 0,
          _301: 0,
          _302: 0,
          _304: 0,
          _400: 0,
          _403: 0,
          _404: 0,
          _411: 0,
          _499: 0,
          _500: 0,
          _502: 0,
          _503: 0,
          _504: 0,
          kt: 1433265000,
          kts: '2015-06-03 01:10:00' }
        ] } }
  • 多区域数多运营商数据查询总和数据
    {
      start_time: '2015-10-01 00:00:00',
      end_time: '2015-10-05 12:00:00',
      region: '浙江,江苏',
      isp: 'ctn,cun',
      sum_data: true
    }
    
    NOTE: 此查询条件返回多区域多运营商的总和数据,不区分具体运营商或者是区域

返回结果参见返回结果

查询流量数据

  • 查询上行流量 { start_time: '2015-10-01 00:00:00', end_time: '2015-10-05 12:00:00', flow_type: 'live', live_type: 'up' }
  • 下行流量 { start_time: '2015-10-01 00:00:00', end_time: '2015-10-05 12:00:00', flow_type: 'live', live_type: 'down' }

NOTE: 流量返回结果中不包含http code 请求次数 动态请求次数,https请求次数只有流量数据, 流量查询支持地区,以及运营商的查询,具体参数请参考以上的地区运营商查询

流量查询结果

[
  {
    "bytes": 234921838,
      "bandwidth": "7266915.52",
      "kt": 1473005100,
      "kts": "2016-09-05 00:05:00"
  },
  {
    "bytes": 174305116,
    "bandwidth": "5391838.25",
    "kt": 1473005400,
    "kts": "2016-09-05 00:10:00"
  },
  {
    "bytes": 33310564,
    "bandwidth": "1030406.78",
    "kt": 1473005700,
    "kts": "2016-09-05 00:15:00"
  }
]

回源数据查询

  • 查询条件 { start_time: '2015-10-01 00:00:00', end_time: '2015-10-05 12:00:00', flow_source: 'backsource', }

NOTE: 回源流量返回结果中不包含命中率 动态请求次数, 不支持地区运营商查询,不支持按照回源地址查询,支持按照空间查询

返回结果

[
  {
    "_503": 4,
    "_403": 685,
    "time": 50365423,
    "_400": 3142,
    "bytes": 123254242556,
    "_302": 131,
    "_301": 595,
    "_206": 2476,
    "_500": 24,
    "_304": 20507,
    "reqs": 643763,
    "_404": 364348,
    "_200": 250039,
    "_502": 2,
    "bandwidth": 3812664569.73,
    "rps": 2145.88,
    "kt": 1473091500,
    "kts": "2016-09-06 00:05:00"
  },
  {
    "_503": 4,
    "_403": 718,
    "time": 46700672,
    "_400": 2071,
    "bytes": 124583141905,
    "_302": 118,
    "_301": 818,
    "_206": 2134,
    "_304": 17432,
    "reqs": 630496,
    "_200": 239393,
    "_404": 366339,
    "_500": 24,
    "bandwidth": 3853771856.26,
    "rps": 2101.65,
    "kt": 1473091800,
    "kts": "2016-09-06 00:10:00"
  }
]

详细结果参数说明

字段 说明
rps 每秒请求数
nhit 未命中数
bandwidth 带宽
bytes 流量
reqs 请求量
time 请求总耗时
cc CC攻击拦截数
inj 注入攻击拦截次数
lreqs 大文件请求次数(大于32k)
ltime 大文件请求时间
lbytes 大文件请求流量
hreqs https请求数
hbytes https请求流量
dreqs 动态请求数
dbytes 动态请求流量
extwaf 其他攻击数量
hit_bytes 缓存命中数量
xss 跨域攻击拦截次数
hit 缓存命中数
_200 200请求数
_206 206请求数
_301 301请求数
_302 302请求数
_304 304请求数
_400 400请求数
_403 403请求数
_411 411请求数
_499 499请求数
_500 500请求数
_502 502请求数
_503 503请求数
_504 504请求数
kt 当前统计时间的时间戳
kts 当前统计时间(后5分钟)
Last edited by jianhua.wang, 2016-09-29 15:45:40