CDN加速

文档中心 API文档 流量报表 查询多域名在各ISP各省份字节命中率(Byte)

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

更新时间:2020-09-01 11:26:14
适用产品:通用功能

接口描述

查询多域名在各ISP各省份字节命中率(Byte)及命中流量。

请求参数

参数名称类型必填描述
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;如果大于当前时间,则重新赋值为当前时间;
domainArray域名,域名个数限制根据账号可调,默认为20个
dataIntervalString数据粒度,5m:5分钟粒度,1h:1小时粒度
provinceArray省份中文名称,可选值为北京、上海、天津、重庆、河北、山西、河南、辽宁、吉林、黑龙江、内蒙古、江苏、山东、安徽、浙江、福建、湖北、湖南、 广东、广西、江西、四川、海南、贵州、云南、西藏、陕西、甘肃、青海、宁夏、新疆、其它,可传入多个值,不传代表查询全部省份
ispArray运营商中文名称,可选值为中国电信、中国铁通、中国联通、中国教育网、中国移动、中国广电、长城宽带、E家宽、其它,可传入多个值,不传代表查询全部运营商
groupByArray分组维度 1.可选值为domain、province、isp,可传入多个值; 2.有传入则按照该维度展示明细数据;

返回参数

参数名称类型描述
domainString域名
ispString运营商
provinceString省份
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命中流量值,单位Byte

错误码

错误代码(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系统发生错误

示例

示例说明
请求示例
复制
#!/bin/bash
# 请将示例中的(-H "X-Time-Zone") 参数设置为您希望在返回结果中获得的时区
# 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/byte"   \
  -X "POST" \
-H "X-Time-Zone:GMT+08:00" \
  -u "$username:$password" \
  -H "Date: $date" \
  -H "Accept: application/json" \
  -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"
      ]
  }'
返回示例
复制
{
      "result":[
          {
                "domain":"test.com",
              "ispData":[
                  {
                        "isp":"中国电信",
                        "provinceData":[
                          {
                                "province":"北京",
                                "hitRateData":[
                                  {
                                        "timestamp":"2017-07-07 00:00",
                                        "value":"0.9900",
                                        "hitFlow":"11000000"
                                  },
                                  {
                                        "timestamp":"2017-07-07 00:05",
                                        "value":"0.3000",
                                        "hitFlow":"30000"
                                  }
                              ]
                          }
                      ]
                  }
              ]
          }
      ]
  }