CDN加速

文档中心 API文档 流量报表 查询多域名在指定结算区域的流量汇总

查询多域名在指定结算区域的流量汇总

更新时间:2020-10-20 15:49:59
适用产品:通用功能

接口描述

获取加速域名在指定结算区域的流量汇总统计数据。

请求参数

参数名称类型必填描述
datefromString开始时间 1.格式为yyyy-MM-ddTHH:mm:ss+08:00; 2.并且小于当前时间和dateTo; 3.dateFrom和dateTo相差不能超过31天(可联系技术支持调整);4.只能查询最近2年内数据。
datetoString结束时间 1.格式为yyyy-MM-ddTHH:mm:ss+08:00; 2.必须大于dateFrom; 3.如果大于当前时间,则重新赋值为当前时间;
domainArray域名列表,不传递则查询全部域名;
dataIntervalString数据粒度 1.可选值为:5m(5分钟)、1h(1小时)、1d(1天); 2.不传时默认为1d; 3.传递5m时,若客户数据采集粒度有特殊配置将按实际配置粒度返回。
areaCodeString查询区域 1.多个区域使用英文分号分隔 2.可选值为:cn、nc、ov、apac、am、euna、emea、sa、af、au、hk、tw等;

返回参数

参数名称类型描述
flow-summaryNumber总流量,保留2位小数,单位为MB
timestampString时间 1.查询的数据粒度为fiveminutes时,格式为yyyy-MM-dd HH:mm;每一个时间片数据值代表的是前一个时间粒度范围内的数据值。一天开始的时间片是yyyy-MM-dd 00:05,最后一个时间片是yyyy-MM-dd 24:00。 2.查询的数据粒度为hourly时,格式为yyyy-MM-dd HH;每一个时间片数据值代表的是前一个时间粒度范围内的数据值。一天开始的时间片是yyyy-MM-dd 01,最后一个时间片是yyyy-MM-dd 24。 3.查询的数据粒度为daily时,格式为yyyy-MM-dd;每一个时间片数据值代表的该天内的数据值; 4.返回开始时间和结束时间包含的时间片。
flowNumber流量,保留2位小数,单位为MB

错误码

错误代码(code)描述(message)HTTP状态码语义
InvalidDatePeriodThe   date specified is invalid.400datefrom或dateto不符合规范
DateSpanErrorYou   cannot specify a period greater than 31.400datefrom和dateto相差超过31天
PARAM_INVALIDparam:   areaCode is null or invalid.400参数areaCode 不符合规范
InvalidHTTPRequestThere   was an error in the body of your HTTP request.400请求体格式错误
InvalidChannelAccess   to the specified resource (invalid channel) has been forbidden.403域名非法
ReportErrorreport   error.400系统发生错误(myview接口返回错误,且错误码非200和403)
InternalErrorWe   encountered an internal error. Please try again.500系统发生错误
PARAM_INVALIDparam: domain is null or invalid.400参数domain不符合规范
PARAM_INVALIDparam: dataInterval is null or invalid.400参数dataInterval 不符合规范

示例

示例说明
请求示例
复制
#!/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/area" \
-X "POST" \
-H "X-Time-Zone:GMT+08:00" \
-u "$username:$password" \
-H "Date: $date" \
-H "Accept: application/xml" \
-d '{
    "dateFrom":"2017-03-01T00:15:00+08:00",
    "dateTo":"2017-03-01T01:14:59+08:00",
    "domain":[
        "test1.com",
        "test2.com"
    ],
    "dataInterval":"5m",
    "areaCode":"cn"
}'
返回示例
复制
<?xml   version="1.0" encoding="utf-8"?>
  <flow-report>
      <flow-summary>0</flow-summary>
    <flow-data>
      <timestamp>2017-03-01   00:15:00</timestamp>
      <flow>0</flow>
    </flow-data>
    <flow-data>
      <timestamp>2017-03-01   00:20:00</timestamp>
      <flow>0</flow>
    </flow-data>
  </flow-report>