CDN加速

文档中心 API文档 查询多域名的回源流量及回源请求数

查询多域名的回源流量及回源请求数

更新时间:2022-05-05 10:39:18

适用产品

全站加速、上传加速、PCDN、DMS、移动加速、应用安全解决方案、政企安全加速解决方案、IPv6一体化解决方案、下载分发、网页加速、WSS、Web应用防火墙、应用安全加速解决方案、BotGuard爬虫管理、区块链安全加速解决方案、电商安全加速解决方案、动态加速、金融安全加速解决方案、IPv6安全加速解决方案、点播分发、DDoS云清洗

接口描述

查询边缘节点及父节点在短时间内的回源流量及回源请求数。 限制说明:一般数据延迟5~15分钟左右。建议调用频率不高于2000次/5分钟。

推荐使用 Open API在线调试

Open API在线调试功能提供可视化界面在线调试API、支持生成代码示例、快速检索查看API文档等能力。前往调试

请求参数

Body 参数

参数名称类型必填描述
dateFrom
String开始时间: 1.时间格式为yyyy-MM-ddTHH:mm:ss+08:00,例如,2016-12-02T10:00:00+08:00(为北京时间2016年12月2日10点0分0秒); 2.不能大于当前时间 3.最多可获取最近半年(183天)的数据。
dateTo
String结束时间: 1.时间格式2016-12-02T10:00:00+08:00 2.结束时间需大于开始时间,结束时间如果大于当前时间,取当前时间。 4.dateFrom,dateTo二者都未传,默认查询过去的24小时;如仅有一个未传,抛异常 5.允许查询最大时间间隔:1天,即dateFrom和dateTo相差不能超过1天(可联系技术支持调整)。
dataInterval
String数据粒度: 1、支持5m(5分钟)。和 1m(1分钟) 2、不传默认5m。
domain
List域名: 1、可传递域名数量上限默认为200个(可联系技术支持调整); 2、未传递该入参时查询账号下所有域名,但当账号下域名数量超过限制时不可查询(报错)。
groupBy
List分组关键词: 1、默认聚合展示;   2、传入关键词则代表需要按照关键词对应的值展示明细; 例如groupBy传domain,则代表返回按照domain明细展开。 3、只能传递domain。
backsrcOnly
Number可选值 0、1 。入参 0 则返回全部数据,入参 1 则只返回回源站数据,默认为 0

返回参数

Body 参数

参数名称类型描述
result
List
domain
String域名
totalFlow
String总流量,单位MB,保留两位小时
totalRequest
String总请求数
peakRequest
String请求数峰值
peakRequestTime
String请求数峰值时间
peakBandwidth
String带宽峰值,单位Mbps,保留2位小数,示例 (931556.21)
peakBandwidthTime
String带宽峰值时间
flowRequestOriginData
List
timestamp
String1.查询的数据粒度为5m时,格式为yyyy-MM-dd   HH:mm;每一个时间片数据值代表的是前一个时间粒度范围内的数据值。一天开始的时间片是yyyy-MM-dd 00:05,最后一个时间片是(yyyy-MM-dd+1)   00:00。 2.返回开始时间和结束时间包含的时间片。
flow
String流量值,单位MB,保留2位小数;
bandwidth
String带宽,单位:Mbps,保留两位小数
request
String请求数

错误码

错误代码(code)描述(message)HTTP状态码语义
DateSpanErrorYou   cannot specify a period greater than 1.400dateFrom和dateTo相差超过1天
InternalErrorWe   encountered an internal error. Please try again.500系统发生错误
InvalidDatePeriodThe   date specified is invalid.400dateFrom或dateTo不符合规范
InvalidHTTPRequestThere   was an error in the body of your HTTP request.400请求体格式错误
NotAcceptableThe   accept header specified in your request is not acceptable.400Accept请求头不支持,接口仅支持json和xml格式,默认为json格式
NumberLimitExceededThe   request was rejected because the number of domainStream(actual) exceeds the   limit (expect).400查询的域名个数超出限制
PARAM_INVALIDparam:   dataInterval is null or invalid.400参数dataInterval不符合规范
PARAM_INVALIDparam: domain is null or invalid.400参数domain不符合规范
PARAM_INVALIDparam: groupBy is null or invalid.400参数groupBy不符合规范

示例

JSON
XML
JSON
请求示例
复制代码 复制成功
#!/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-request/origin"   \
  -X "POST" \
-H "X-Time-Zone:GMT+08:00" \
  -u "$username:$password" \
  -H "Date: $date" \
  -H "Accept: application/json" \
  -d '{
  "dateFrom": "2019-07-22T14:00:00+08:00",
  "dateTo": "2019-07-22T14:05:00+08:00",
  "domain": ["www.111.com","www.222.com"],
  "dataInterval": "5m",
  "groupBy": ["domain"]
  }'
返回示例
复制代码 复制成功
{
    "result": [
        {
            "domain":"www.111.com",
            "totalFlow": "774.67",
            "totalRequest": "25659",
            "peakBandwidth": "20.66",
            "peakBandwidthTime": "2019-07-22 14:00",
            "peakRequest": "25659",
            "peakRequestTime": "2019-07-22 14:00",
            "flowRequestOriginData": [
                {
                    "timestamp": "2019-07-22 14:00",
                    "bandwidth": "20.66",
                    "flow": "774.67",
                    "request": "25659"
                }
            ]
        },
        {
            "domain":"www.222.com",
            "totalFlow": "774.67",
            "totalRequest": "25659",
            "peakBandwidth": "20.66",
            "peakBandwidthTime": "2019-07-22 14:00",
            "peakRequest": "25659",
            "peakRequestTime": "2019-07-22 14:00",
            "flowRequestOriginData": [
                {
                    "timestamp": "2019-07-22 14:00",
                    "bandwidth": "20.66",
                    "flow": "774.67",
                    "request": "25659"
                }
            ]
        },
        {
            "domain":"www.111.com",
            "totalFlow": "1394.00",
            "totalRequest": "25920",
            "peakBandwidth": "37.17",
            "peakBandwidthTime": "2019-07-22 14:05",
            "peakRequest": "25920",
            "peakRequestTime": "2019-07-22 14:05",
            "flowRequestOriginData": [
                {
                    "timestamp": "2019-07-22 14:05",
                    "bandwidth": "37.17",
                    "flow": "1394.00",
                    "request": "25920"
                }
            ]
        },
        {
            "domain":"www.222.com",
            "totalFlow": "2013.33",
            "totalRequest": "26181",
            "peakBandwidth": "53.69",
            "peakBandwidthTime": "2019-07-22 14:05",
            "peakRequest": "26181",
            "peakRequestTime": "2019-07-22 14:05",
            "flowRequestOriginData": [
                {
                    "timestamp": "2019-07-22 14:05",
                    "bandwidth": "53.69",
                    "flow": "2013.33",
                    "request": "26181"
                }
            ]
        }
    ]
}