CDN加速

文档中心 API文档 流量报表 查询直播推拉流域名下的各个目录的流量/带宽

查询直播推拉流域名下的各个目录的流量/带宽

更新时间:2021-05-26 13:51:49

适用产品:直播加速

接口描述

查询指定时间段内单域名下的各目录的流量/带宽统计,默认粒度为5分钟。

请求参数

JSON
参数名称类型必填描述
dateFromString开始时间 1.格式为yyyy-MM-ddTHH:mm:ss+08:00; 2.必须小于当前时间和dateTo; 3.dateFrom和dateTo相差不能超过7天(可联系技术支持调整);4.只能查询最近2年内数据。
dateToString结束时间 1.格式为yyyy-MM-ddTHH:mm:ss+08:00; 2.必须大于dateFrom; 3.如果大于当前时间,则重新赋值为当前时间;
domainString域名 1.需要满足域名的正则校验; 2.域名个数限制根据账号可调,默认为20个;
dirArray目录 1.目录个数限制根据账号可调,默认为200个; 2.不传代表查询该域名下的所有目录,同时接受目录个数限制; 3.无效的目录不返回
protocolTypeString查询协议 1.代表统计http协议或https协议; 2.可选值:http   或 https ; 3.不传默认代表不区分http和https;
dataIntervalString查询粒度 1.不传默认代表5分钟粒度; 2.可选值:5m   或 1m; 3.1m选项根据账号在数据字典flowDirDataIntervalConfig中可配;
dataTypeString查询类型 1.可选值:flow   或bandwidth; 2.bandwidth代表获取带宽值,flow代表获取流量值,默认查询所有区域的数据;

返回参数

JSON
参数名称类型描述
domainString域名
dirString目录
timestampString时间 1.查询的数据粒度为1m时,格式为yyyy-MM-dd HH:mm;每一个时间片数据值代表的是前一个时间粒度范围内的数据值。一天开始的时间片是yyyy-MM-dd   00:01,最后一个时间片是(yyyy-MM-dd+1)00:00; 2.查询的数据粒度为5m时,格式为yyyy-MM-dd HH:mm;每一个时间片数据值代表的是前一个时间粒度范围内的数据值。一天开始的时间片是yyyy-MM-dd   00:05,最后一个时间片是(yyyy-MM-dd+1)00:00; 3.返回开始时间和结束时间包含的时间片。
valueString时间点的数据,保留2位小数
bandwidthPeakValueString当dataType为bandwidth时返回; 每路流在该时间段内的带宽峰值单位Mbps,保留2位小数;
totalFlowString当dataType为flow时返回; 每路流的总流量单位MB,保留2位小数;

错误码

错误代码(code)描述(message)HTTP状态码语义
InvalidHTTPRequestThere   was an error in the body of your HTTP request.400请求体格式错误
InvalidDatePeriodThe   date specified is invalid.400dateFrom或dateTo不符合规范
DateSpanErrorYou   cannot specify a period greater than 7.400dateFrom和dateTo相差超过7天
NoSuchDomainThe   specified domain does not exist.404传递的域名不存在
DomainsExcessiveThe   number of domain is excessive once.403传递的域名个数超过账号限制
DirExcessiveThe   number of dir is excessive once.403传递的目录个数超过账号限制
PARAM_INVALIDparam:   dir is null or invalid.400参数dir不符合规范
InternalErrorWe   encountered an internal error. Please try again.500系统发生错误

示例

JSON
XML
示例说明
请求示例
复制
#!/bin/bash
# 请将示例中的(-H "X-Time-Zone") 参数设置为您希望在返回结果中获得的时区
# Please remember to change the param (-H "X-Time-Zone") in this demo to the TimeZone you want in response

username='example_username'
apiKey='example_apiKey'
date=`env LANG="en_US.UTF-8" date -u "+%a, %d %b %Y %H:%M:%S GMT"`
password=`echo -en "$date" | openssl dgst -sha1 -hmac $apiKey -binary | openssl enc -base64`
curl -i --url "https://open.chinanetcenter.com/api/report/flow/dir/detail" \
-X "POST" \
-H "X-Time-Zone:GMT+08:00" \
-u "$username:$password" \
-H "Date: $date" \
-H "Accept: application/json" \
-d '{
    "dateFrom":"2017-05-24T16:20:00+08:00",
    "dateTo":"2017-05-24T16:40:00+08:00",
    "domainDir":[
        {
            "domain":"test.com",
            "dir":[
                "aa"
            ]
        }
    ],
    "dataInterval":"5m",
    "dataType":"flow",
    "protocolType":"http"
}'
返回示例
复制
//查询dataType为flow
  {
      "result":[
          {
                "domain":"test.com",
              "details":[
                  {
                        "dir":"aa",
                        "totalFlow":"3147.04",
                      "details":[
                          {
                                "timestamp":"2017-05-24 16:20",
                                "value":"730.68"
                          },
                          {
                                "timestamp":"2017-05-24 16:25",
                                "value":"752.67"
                          },
                          {
                                "timestamp":"2017-05-24 16:30",
                                "value":"595.05"
                          }
                      ]
                  }
              ]
          }
      ]
  }
   
  //查询dataType为bandwidth
  {
      "result":[
          {
                "domain":"test.tv",
              "details":[
                  {
                        "dir":"aa",
                        "bandwidthPeakValue":"15.65",
                        "details":[
                          {
                                "timestamp":"2017-05-24 16:40",
                                "value":"15.65"
                          },
                          {
                              "timestamp":"2017-05-24   16:45",
                                "value":"15.00"
                          },
                          {
                                "timestamp":"2017-05-24 16:50",
                                "value":"11.92"
                          }
                      ]
                  }
              ]
          }
      ]
  }