文档中心 API文档 查询多域名在各ISP各省请求数命中率

查询多域名在各ISP各省请求数命中率

更新时间:2022-10-31 10:26:45

适用产品

网页加速、下载分发、动态加速、全站加速、点播分发、直播分发、上传加速、移动加速、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结束时间: 1.时间格式yyyy-MM-ddTHH:mm:ss+08:00 2.结束时间需大于开始时间,结束时间如果大于当前时间,取当前时间。 3.dateFrom,dateTo二者都未传,默认查询过去的24小时;如仅有一个未传,抛异常 4.允许查询最大时间间隔:7天,即dateFrom和dateTo相差不能超过7天。 (可联系技术支持调整)
domain
List域名: 1.可传递域名数量上限默认为20个(可联系技术支持调整); 2.自动过滤掉无效域名(如传递非法域名,会被过滤掉,查询结果只返回有效域名的数据)。
dataInterval
String数据粒度: 1.支持5m(5分钟)、1h(1小时) 2.不传默认5m。
province
List默认查询全部省份,传递省份中文名称,省份信息码表详见概览页附录说明章节
isp
List默认查询全部运营商,传递运营商中文名称,运营商信息码表详见概览页附录说明章节
groupBy
List分组关键词: 1.默认聚合展示; 2.可选值为domain、province、isp,可传入多个值; 3.传入关键词则代表需要按照关键词对应的值展示明细; 例如groupBy传入isp,则isp维度需要明细展示;当没有传递isp,则代表isp聚合展示,同时isp节点则不返回。其他province和domain相同逻辑。 例如:传递'groupBy': ['domain','province'],则ispData下的isp节点无需返回。 { 'domain': 'www.aaaa.com', 'ispData': [ {'isp': '中国电信','provinceData': [....] }]}

返回参数

Body 参数

参数名称类型描述
result
List结果
domain
String域名
ispData
ListISP数据
isp
String运营商
provinceData
List省份数据
province
String省份
hitRateData
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请求数命中率,保留4位小数
hitRequest
String命中请求数 (该字段默认不提供,需要该字段可联系配置支持)

错误码

错误代码(code)描述(message)HTTP状态码语义
MissingBodyThis   operation requires a body. Ensure that the body is present and the   Content-Type header is set.400请求体没有传递
NotAcceptableThe   accept header specified in your request is not acceptable.400Accept请求头不支持,接口仅支持json和xml格式,默认为json格式
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系统发生错误
PARAM_INVALIDparam: domain is null or invalid.400参数domain不符合规范
PARAM_INVALIDparam: dataInterval is null or invalid.400参数dataInterval不符合规范
PARAM_INVALIDparam: province is null or invalid.400参数province不符合规范
PARAM_INVALIDparam: isp is null or invalid.400参数isp不符合规范

示例

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