文档中心 API文档 查询多域名在各ISP各省份字节命中率

查询多域名在各ISP各省份字节命中率

更新时间:2023-12-14 10:50:06

适用产品

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

接口描述

查询多域名在各ISP各省份字节命中率及命中流量。 支持语言请求头Accept-Language,只支持zh-CN、en-US,默认为zh-CN。Accept-Language:en-US时,省份及运营商 入参及返回都为code,否则返回的为中文。

调用频率

单用户调用频率:300/5min

推荐使用 Open API在线调试

Open API在线调试功能提供可视化界面在线调试API、支持生成代码示例、快速检索查看API文档等能力。前往调试

请求参数

Body 参数

参数名称描述
dateFromString
开始时间 1.格式为yyyy-MM-ddTHH:mm:ss+08:00; 2.必须大于当前时间-183天,并且小于当前时间和dateTo; 3.dateFrom和dateTo相差不能超过7天;(可联系技术支持调整) 4.dateFrom和dateTo要么都传递,要么都不传递; 5.dateFrom和dateTo都未传递,则默认查询过去24小时的数据
dateToString
结束时间 1.格式为yyyy-MM-ddTHH:mm:ss+08:00; 2.必须大于dateFrom;如果大于当前时间,则重新赋值为当前时间;
*domainList
域名,域名个数限制根据账号可调,默认为20个
dataIntervalString
数据粒度,5m:5分钟粒度,1h:1小时粒度
provinceList
省份 1.未传递province时:查询所有省份,返回的数据按照所有省份聚合。 2.有传递province时:省份 可传中文或code。省份信息码表详见概览页附录说明章节 3.支持语言请求头Accept-Language,只支持zh-CN、en-US,默认为zh-CN。Accept-Language:en-US时,省份及运营商 入参及返回都为code,否则返回的为中文。
ispList
运营商: 1.未传递isp时:查询所有isp,返回的数据按照所有运营商聚合。 2.有传递isp时:运营商 可传中文或code。运营商信息码表详见概览页附录说明章节
groupByList
分组维度 1.可选值为domain、province、isp,可传入多个值; 2.有传入则按照该维度展示明细数据;

返回参数

Body 参数

参数名称描述
resultList
domainString
域名
ispDataList
ispString
运营商
provinceDataList
provinceString
省份
hitRateDataList
timestampString
时间, 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.返回开始时间和结束时间包含的时间片。
valueString
字节命中率,保留4位小数
hitFlowString
命中流量值,单位MB,保留2位小数; 默认不返回该字段,需要返回的请联系技术支持

错误码

错误代码(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不符合规范

示例

XML
JSON中文示例
JSON英文示例
XML
请求示例
复制代码 复制成功
#!/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/hit-rate/isp-province" \
-X "POST" \
-H "X-Time-Zone:GMT+08:00" \
-u "$username:$password" \
-H "Date: $date" \
-H "Accept: application/xml" \
-d '{
    "dateFrom":"2017-07-07T00:00:00+08:00",
    "dateTo":"2017-07-08T24:00:00+08:00",
    "domain":[
        "test.com"
    ],
    "dataInterval":"5m",
    "province":[
        "北京",
        "天津"
    ],
    "isp":[
        "中国电信"
    ],
    "groupBy":[
        "domain",
        "isp",
        "province"
    ]
}'
返回示例
复制代码 复制成功
<report>
     <result>
        <domain-isp-data>
             <domain>test.com</domain>
           <isp-data>
              <isp-province-data>
                 <isp>中国电信</isp>
                 <province-data>
                      <province-measure-data>
                       <province>北京</province>
                         <hit-rate-data>
                          <detail>
                               <timestamp>2017-07-07 00:00</timestamp>
                               <value>0.9900</value>
                               <hit-flow>11000000.00</hit-flow>
                          </detail>
                          <detail>
                               <timestamp>2017-07-07 00:05</timestamp>
                               <value>0.3000</value>
                               <hit-flow>30000.00</hit-flow>
                          </detail>
                         </hit-rate-data>
                      </province-measure-data>
                 </province-data>
              </isp-province-data>
           </isp-data>
        </domain-isp-data>
     </result>
  </report>
本篇文档内容对您是否有帮助?
有帮助
我要反馈
提交成功!非常感谢您的反馈,我们会继续努力做到更好!