查询多域名在指定结算区域的流量汇总
更新时间：2023-05-09 20:10:38
适用产品
网页加速、下载分发、动态加速、全站加速、点播分发、直播分发、上传加速、移动加速、S-P2P、PCDN、应用性能管理、WEB应用防火墙、BotGuard爬虫管理、WSS、DMS、DDoS云清洗、应用安全加速解决方案、IPv6一体化解决方案、电商安全加速解决方案、金融安全加速解决方案、政企安全加速解决方案、应用安全解决方案、区块链安全加速解决方案、IPv6安全加速解决方案
接口描述
获取加速域名在指定结算区域的流量汇总统计数据。
- 调用URL： https://open.chinanetcenter.com/api/report/flow/area
- 调用方法：POST
- 数据延迟：5~15min
推荐使用 Open API在线调试
Open API在线调试功能提供可视化界面在线调试API、支持生成代码示例、快速检索查看API文档等能力。前往调试
请求参数
Body 参数
| 参数名称 | 描述 |
|---|---|
*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.如果大于当前时间,则重新赋值为当前时间; |
domainList | 域名列表,不传递则查询全部域名; |
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等; |
返回参数
Body 参数
| 参数名称 | 描述 |
|---|---|
flow-summaryInteger | 总流量,保留2位小数,单位为MB |
flow-dataList | |
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.返回开始时间和结束时间包含的时间片。 |
flowInteger | 流量,保留2位小数,单位为MB |
错误码
| 错误代码（code） | 描述（message） | HTTP状态码 | 语义 |
|---|---|---|---|
| InvalidDatePeriod | The date specified is invalid. | 400 | datefrom或dateto不符合规范 |
| DateSpanError | You cannot specify a period greater than 31. | 400 | datefrom和dateto相差超过31天 |
| PARAM_INVALID | param: areaCode is null or invalid. | 400 | 参数areaCode 不符合规范 |
| InvalidHTTPRequest | There was an error in the body of your HTTP request. | 400 | 请求体格式错误 |
| InvalidChannel | Access to the specified resource (invalid channel) has been forbidden. | 403 | 域名非法 |
| ReportError | report error. | 400 | 系统发生错误（myview接口返回错误，且错误码非200和403） |
| InternalError | We encountered an internal error. Please try again. | 500 | 系统发生错误 |
| PARAM_INVALID | param: domain is null or invalid. | 400 | 参数domain不符合规范 |
| PARAM_INVALID | param: dataInterval is null or invalid. | 400 | 参数dataInterval 不符合规范 |
示例
JSON
- 请求示例 复制成功
#!/bin/bash # 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/json" \ -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" }'- 返回示例 复制成功
{ "flow-summary": "0", "flow-data": [ { "timestamp": "2019-06-17 00:05:00", "flow": "0" }, { "timestamp": "2019-06-17 00:10:00", "flow": "0" }, { "timestamp": "2019-06-17 00:15:00", "flow": "0" }, { "timestamp": "2019-06-17 00:20:00", "flow": "0" } ] }
本篇文档内容对您是否有帮助？
有帮助
我要反馈