查询多域名分钟级别的边缘带宽-文档中心

POST

https://api.cdnetworks.com/api/report/bandwidth/multi-domain/real-time/edge

查询多域名分钟级别的边缘带宽

数据延迟：5-10min
单用户调用频率：300/5min
适用产品：应用性能管理、Bot Shield、Flood Shield、静态加速、动态加速、流媒体直播、低延时直播、流媒体点播、云直播、云点播、Flood Shield 2.0

请求参数

Body 参数

参数名称	描述
dateFromString	开始时间：时间格式为yyyy-MM-ddTHH:mm:ss+08:00，例如，2019-01-01T10:00:00+08:00（为北京时间2019年1月1日10点0分0秒）；不能大于当前时间最多可获取最近半年（183天）的数据。
dateToString	结束时间：时间格式为yyyy-MM-ddTHH:mm:ss+08:00 结束时间需大于开始时间，结束时间如果大于当前时间，取当前时间。 dateFrom，dateTo二者都未传，默认查询过去的1小时；如仅有一个未传，抛异常允许查询最大时间间隔：默认1小时，即dateFrom和dateTo相差不能超过1小时（可联系技术支持调整，最长31天）。
dataIntervalString	数据粒度：不传默认1m 支持1m（1分钟）、5m（5分钟）
*domainList	域名：可传递域名数量上限默认为20（可联系技术支持调整）；自动过滤掉非法域名（如传递非法域名，会被过滤掉，查询结果只返回合法域名的数据）
groupByString	分组维度可选值为domain；有传入则按照该维度展示明细数据；

返回参数

Body 参数

参数名称	描述
codeString	请求结果状态码
messageString	请求结果信息
- dataList
domainString	域名，如果不选择域名分组维度，该字段为所有域名以分号分隔的字符串
peakValueString	峰值带宽，单位Mbps，示例（9811.21Mbps)
peakTimeString	峰值时间，示例（2019-02-13 18:01）
totalString	边缘总流量，单位MB，示例 ( 74099.91MB)
- bandwidthDataList
timestampString	格式为yyyy-MM-dd HH:mm；每一个时间片数据值代表的是前一个时间粒度范围内的数据值。一天开始的时间片是yyyy-MM-dd 00:01，最后一个时间片是第二天（yyyy-MM-dd） 00:00。返回开始时间和结束时间包含的时间片
valueString	带宽值，单位Mbps，保留2位小数。

错误码

错误代码（code）	描述（message）	HTTP状态码	语义
24102014	This operation requires a body. Ensure that the body is present and the Content-Type header is set.	400	请求体没有传递
24102013	The accept header specified in your request is not acceptable.	400	Accept请求头不支持，接口仅支持json和xml格式，默认为json格式
24102002	There was an error in the body of your HTTP request.	400	请求体格式错误
24102006	The date specified is invalid.	400	dateFrom或dateTo不符合规范或时间区间不合法
24102007	You cannot specify a period greater than xx minute(s).	400	dateFrom和dateTo相差超过限制值
24102021	Date format error	400	日期格式错误
24102008	param:domain is null or invalid.	400	参数domain不符合规范
24102008	param:dataInterval is null or invalid.	400	参数dataInterval不符合规范
24102008	param:groupBy is null or invalid.	400	参数groupBy不符合规范
24102019	The request was rejected because the number of Domain(xx) exceeds the limit (xx).	400	传递的域名个数超过账号限制
24102500	We encountered an internal error. Please try again.	500	系统发生错误

示例

JSON

请求示例 复制代码 复制成功#!/bin/bash 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://api.cdnetworks.com/api/report/bandwidth/multi-domain/real-time/edge" \ -X "POST" \ -u "$username:$password" \ -H "Date: $date" \ -H "Accept: application/json" \ -d ' { "dateFrom": "2019-01-01T10:00:00+08:00", "dateTo": "2019-01-01T11:00:00+08:00", "domain": ["www.baidu1.com","www.baidu2.com"], "dataInterval": "1m", "groupBy":"domain"}'

#!/bin/bash
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://api.cdnetworks.com/api/report/bandwidth/multi-domain/real-time/edge" \
-X "POST" \
-u "$username:$password" \
-H "Date: $date" \
-H "Accept: application/json" \
-d '
 
{
"dateFrom": "2019-01-01T10:00:00+08:00",
"dateTo": "2019-01-01T11:00:00+08:00",
"domain": ["www.baidu1.com","www.baidu2.com"],
"dataInterval": "1m",
"groupBy":"domain"}'

返回示例 复制代码 复制成功{ "code":"0", "message":"success", "data":[ { "domain":"www.aaa.com", "peakValue":"1200.00", "peakTime":"2019-11-20 17:00", "total":"62000.00", "bandwidthData":[ { "timestamp":"2019-11-20 18:00", "value":"52.42" }, { "timestamp":"2019-11-20 19:50", "value":"5.39" } ] }, { "domain":"www.bbb.com", "peakValue":"1200.00", "peakTime":"2019-11-20 16:00", "total":"62000.00", "bandwidthData":[ { "timestamp":"2019-11-20 18:00", "value":"5.39" }, { "timestamp":"2019-11-20 19:50", "value":"5.39" } ] } ] }

{
    "code":"0",
    "message":"success",
    "data":[
        {
            "domain":"www.aaa.com",
            "peakValue":"1200.00",
            "peakTime":"2019-11-20 17:00",
            "total":"62000.00",
            "bandwidthData":[
                {
                    "timestamp":"2019-11-20 18:00",
                    "value":"52.42"
                },
                {
                    "timestamp":"2019-11-20 19:50",
                    "value":"5.39"
                }
            ]
        },
        {
            "domain":"www.bbb.com",
            "peakValue":"1200.00",
            "peakTime":"2019-11-20 16:00",
            "total":"62000.00",
            "bandwidthData":[
                {
                    "timestamp":"2019-11-20 18:00",
                    "value":"5.39"
                },
                {
                    "timestamp":"2019-11-20 19:50",
                    "value":"5.39"
                }
            ]
        }
    ]
}

本篇文档内容对您是否有帮助？

有帮助

我要反馈

查询多域名分钟级别的边缘带宽

请求参数

Body 参数

返回参数

Body 参数

错误码

示例

目录