文档中心 API文档 查询Iaas各ISP各省份流量

查询Iaas各ISP各省份流量

更新时间:2022-11-18 17:36:00

适用产品

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

接口描述

查询边缘计算服务器的各ISP各省份流量。

推荐使用 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{'en':'End Time: 1. Time format 2016-12-02T10:00:00+08:00 2. The end time needs to be greater than the start time. If the end time is greater than the current time, the current time is taken. 3. dateFrom, dateTo are not passed, the default query for the past 24 hours; if there is only one untransmitted, throw an exception 4. Allow query maximum time interval: 7 days, that is, the difference between dateFrom and dateTo can't exceed 7 days (can contact technical support adjustment).', 'zh_CN':'结束时间: 1. 时间格式2016-12-02T10:00:00+08:00 2. 结束时间需大于开始时间,结束时间如果大于当前时间,取当前时间。 3. dateFrom,dateTo二者都未传,默认查询过去的24小时;如仅有一个未传,抛异常 4. 允许查询最大时间间隔:7天,即dateFrom和dateTo相差不能超过7天(可联系技术支持调整)。'}
domain
List域名: 1. 可传递域名数量上限默认为20个(可联系技术支持调整)。未传递该入参时查询账号下所有域名,但当账号下域名数量超过限制时不可查询(报错)。 2. 自动过滤掉非法域名(如传递非法域名,会被过滤掉,查询结果只返回合法域名的数据)。
dataInterval
String数据粒度,默认为5m(5分钟,当前只支持5m)
province
List省份中文名称: 1. 不传默认查询全部省份; 2. 可传递的值详见概览页省份列表说明。
isp
List运营商中文名称: 1. 不传默认查询全部运营商; 2. 可传递的值详见概览页运营商列表说明。
type
List流量类型: 1. 可传递值范围:trafficOut(流出)、trafficIn(流入) 2. 可传递多个,不传默认流出,传递多个时返回合并流量。
groupBy
List分组维度: 1. 可选值为domain、province、isp,可传入单个或多个值; 2. 有传入则按照该维度展示明细数据; 3. 返回结果层级顺序固定,入参顺序不影响返回结果顺序。例如:'groupBy': ['domain','province']与'groupBy': ['province','domain']返回结果一样。 例如:传递'groupBy': ['domain','province'],则ispData下的isp节点无需返回。

返回参数

Body 参数

参数名称类型描述
result
List
domain
String域名
ispData
List
isp
String运营商中文名称
provinceData
List
province
String省份中文名称
flowData
List
timestamp
String时间 1. 查询的数据粒度为5m时,格式为yyyy-MM-dd HH:mm;每一个时间片数据值代表的是前一个时间粒度范围内的数据值。一天开始的时间片是yyyy-MM-dd 00:05,最后一个时间片是(yyyy-MM-dd+1) 00:00。 2. 查询的数据粒度为1h时,格式为yyyy-MM-dd HH;每一个时间片数据值代表的是前一个时间粒度范围内的数据值。一天开始的时间片是yyyy-MM-dd 01,最后一个时间片是(yyyy-MM-dd+1) 00。 3. 返回开始时间和结束时间包含的时间片。
value
String流量值,单位为MB,保留两位小数

错误码

错误代码(code)描述(message)HTTP状态码语义
NotAcceptableThe accept header specified in your request   is not acceptable.400Accept请求头不支持,接口仅支持json和xml格式,默认为json格式
MissingBodyThis operation requires a body. Ensure that   the body is present and the Content-Type header is set.400请求体没有传递
InvalidHTTPRequestThere was an error in the body of your HTTP   request.400请求体格式错误
InvalidDatePeriodThe date specified is invalid.400dateFrom或dateTo不符合规范
DateSpanErrorYou cannot specify a period greater than 7.400dateFrom和dateTo相差超过7天
DomainsExcessiveThe number of domain is excessive once.403传递的域名个数超过账号限制
PARAM_INVALIDparam: groupBy is null or invalid.400参数groupBy不符合规范
InternalErrorWe encountered an internal error. Please   try again.500系统发生错误

示例

JSON
XML
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/domain-isp-province/iaas"   \
  -X "POST" \
-H "X-Time-Zone:GMT+08:00" \
  -u "$username:$password" \
  -H "Date: $date" \
  -H "Accept: application/json" \
  -d '{
      "dateFrom":   "2016-12-02T10:00:00+08:00",
      "dateTo":   "2016-12-03T10:00:00+08:00",
      "domain": [
          "www.test.com"
      ],
      "dataInterval":   "5m",
      "province": [
          "北京",
          "天津"
      ],
      "isp": [
          "中国电信"
      ],
      "type": [
          "trafficOut"
      ],
      "groupBy": [
          "domain",
          "isp",
          "province"
      ]
  }'
返回示例
复制代码 复制成功
{
      "result": [
          {
              "domain":   "www.test.com",
              "ispData": [
                  {
                      "isp":   "中国电信",
                        "provinceData": [
                          {
                                "province": "北京",
                                "flowData": [
                                  {
                                        "timestamp": "2016-10-13 00:00",
                                        "value": "88.52"
                                  },
                                  {
                                        "timestamp": "2016-10-13 00:05",
                                        "value": "88.52"
                                  }
                              ]
                          },
                          {
                                "province": "天津",
                                "flowData": [
                                  {
                                        "timestamp": "2016-10-13 00:00",
                                        "value": "88.52"
                                  },
                                  {
                                        "timestamp": "2016-10-13 00:05",
                                        "value": "88.52"
                                  }
                              ]
                          }
                      ]
                  }
              ]
          }
      ]
  }
本篇文档内容对您是否有帮助?
有帮助
我要反馈
提交成功!非常感谢您的反馈,我们会继续努力做到更好!