查询多域名分钟级别的边缘带宽
更新时间：2021-12-14 10:40:46
适用产品
网页加速、下载分发、动态加速、全站加速、点播分发、直播分发、上传加速、移动加速、S-P2P、PCDN、应用性能管理、WEB应用防火墙、BotGuard爬虫管理、WSS、DMS、DDoS云清洗、应用安全加速解决方案、IPv6一体化解决方案、电商安全加速解决方案、金融安全加速解决方案、政企安全加速解决方案、应用安全解决方案、区块链安全加速解决方案、IPv6安全加速解决方案
接口描述
查询多域名分钟级别的边缘带宽
- 调用URL： https://open.chinanetcenter.com/api/report/bandwidth/multi-domain/real-time/edge
- 调用方法：POST
- 数据延迟：5-10分钟
推荐使用 Open API在线调试
Open API在线调试功能提供可视化界面在线调试API、支持生成代码示例、快速检索查看API文档等能力。前往调试
请求参数
Body 参数
| 参数名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
dateFrom | String | 否 | 开始时间： 时间格式为yyyy-MM-ddTHH:mm:ss+08:00，例如，2019-01-01T10:00:00+08:00（为北京时间2019年1月1日10点0分0秒）； 不能大于当前时间 最多可获取最近半年（183天）的数据。 |
dateTo | String | 否 | 结束时间： 时间格式为yyyy-MM-ddTHH:mm:ss+08:00 结束时间需大于开始时间，结束时间如果大于当前时间，取当前时间。 dateFrom，dateTo二者都未传，默认查询过去的1小时；如仅有一个未传，抛异常 允许查询最大时间间隔：1小时（可联系技术支持调整），即dateFrom和dateTo相差不能超过1小时。 |
dataInterval | String | 否 | 数据粒度：不传默认1m 支持1m（1分钟）、5m（5分钟） |
domain | List | 是 | 域名： 可传递域名数量上限默认为20（可联系技术支持调整）； 自动过滤掉非法域名（如传递非法域名，会被过滤掉，查询结果只返回合法域名的数据） |
groupBy | String | 否 | 分组维度 可选值为domain； 有传入则按照该维度展示明细数据； |
返回参数
Body 参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
code | String | 请求结果状态码 |
message | String | 请求结果信息 |
data | List | 请求结果的详细数据 |
domain | String | 域名，如果不选择域名分组维度，该字段为所有域名以分号分隔的字符串 |
peakValue | String | 峰值带宽，单位Mbps，示例 （931556.21) |
peakTime | String | 峰值时间，示例（2019-02-13 18:01） |
total | String | 边缘总流量，单位MB，示例 ( 74099.92) |
bandwidthData | List | |
timestamp | String | 格式为yyyy-MM-dd HH:mm；每一个时间片数据值代表的是前一个时间粒度范围内的数据值。 一天开始的时间片是yyyy-MM-dd 00:01，最后一个时间片是第二天（yyyy-MM-dd） 00:00。 返回开始时间和结束时间包含的时间片 |
value | String | 带宽值，单位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://open.chinanetcenter.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" } ] } ] }
本篇文档内容对您是否有帮助？
有帮助
我要反馈