CDN

查询命中率详情

最近更新时间:2019-03-27 17:51:26

GetHitRateDetailedData

描述

本接口用于获取域名流量命中率、请求数命中率详细数据,单位:百分比

  • 支持按指定的起止时间查询,两者需要同时指定
  • 支持批量域名查询,多个域名ID用逗号(半角)分隔
  • 最多可获取最近一年内93天跨度的数据
  • 统计粒度:5分钟粒度;10分钟粒度;20分钟粒度;1小时粒度;4小时粒度;8小时粒度;1天粒度; 以上粒度的命中率均取该粒度时间段的流量之和、请求数之和计算所得
  • 时效性:5分钟延迟
  • 接口性能:接口最大吞吐量为10000,即DomainId个数*(EndTime-StartTime) /统计粒度 <= 10000。注:在获取多个域名合并值时,DomainId个数按照1计算
  • 使用场景:

    • 客户查询单个域名或多域名合并后实时命中率数据,用于绘制一条命中率线图
    • 客户查询单个域名的详细命中率数据,进行数据保存及数据分析
  • 说明:

    • 请求数命中率=[1-回源请求数/服务请求数]*100%
    • 流量命中率=[1-回源流量/服务流量]*100%
    • 当服务请求数或服务流量为0时,命中率为0

请求语法

本接口请求需要包含指定目录 /2016-09-01/statistics/GetHitRateDetailedData和公共请求header和该接口所特有的请求参数,具体请求语句参照下文请求示例。

请求参数

参数名 必选 类型及范围 说明
StartTime String 获取数据起始时间点,日期格式按ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如: 2016-08-01T21:14+0800
EndTime String 结束时间需大于起始时间;获取日期格式按照ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如: 2016-08-01T21:14+0800
CdnType String 产品类型,只允许输入一种类型,取值为file:大文件下载,video:音视频点播,page:图片小文件,live:流媒体直播,当前暂不支持直播类型
DomainIds String 域名ID,缺省为当前产品类型下的全部域名,可输入需要查询的域名ID,支持批量域名查询,多个域名ID用逗号(半角)分隔
ResultType Long 取值为0:多域名数据做合并;1:每个域名的数据分别返回
Granularity Long 统计粒度,取值为 5(默认):5分钟粒度;10:10分钟粒度;20:20分钟粒度;60:1小时粒度;240:4小时粒度;480:8小时粒度;1440:1天粒度;以上粒度的命中率均取该粒度时间段的流量之和、请求数之和计算所得
HitType String 数据类型, 取值为flowhitrate:流量命中率;reqhitrate:请求数命中率; 支持多类型选择,多个类型用逗号(半角)分隔,缺省为reqhitrate

返回参数

参数名 类型及范围 说明
StartTime String 开始时间
EndTime String 结束时间
CdnType String 产品类型
DomainIds String 域名ID列表,逗号(半角)间隔
ResultType Long 取值为0:多域名数据做合并返回;1:每个域名的数据分别返回
Granularity Long 统计粒度,取值为 5:5分钟粒度;10:10分钟粒度;20:20分钟粒度;60:1小时粒度;240:4小时粒度;480:8小时粒度;1440:1天粒度
HitType String 数据类型, 取值为flowhitrate:流量命中率; reqhitrate:请求数命中率; 支持多类型选择,多个类型用逗号(半角)分隔,缺省为reqhitrate
Datas HitRateDataByTime[] 每个时间粒度的命中百分占比数据

HitRateDataByTime

参数名 类型及范围 说明
Time String 时间点
FlowHitRate Double 流量命中率(所选域名合并值)
ReqHitRate Double 请求数命中率(所选域名合并值)
Domains HitRateDataByDomain[] 每个域名的详细命中率数据(仅当ResultType取值为1时返回此项数据))

HitRateDataByDomain

参数名 类型及范围 说明
DomainId String 域名ID
FlowHitRate Double 流量命中率(该域名的流量命中率)
ReqHitRate Double 请求数命中率(该域名的请求数命中率)

示例

请求示例

GET方式:

GET /2016-09-01/statistics/GetHitRateDetailedData?StartTime=2016-07-31T21:14%2b0800&EndTime=2016-07-31T21:16%2b0800&CdnType=video&ResultType=1&Granularity=5&DataType=reqhitrate 1.1
Host: cdn.api.ksyun.com
X-Amz-Date: date
Authorization:authorization string
x-action: GetHitRateDetailedData
x-version: 2016-09-01

POST方式:

POST /2016-09-01/statistics/GetHitRateDetailedData 1.1
Host: cdn.api.ksyun.com
X-Amz-Date: date
Authorization:authorization string
x-action: GetHitRateDetailedData
x-version: 2016-09-01
Content-Type: application/json
{
 "StartTime": "2016-07-31T21:14+0800",
 "EndTime": "2016-07-31T21:16+0800",
 "CdnType": "video",
 "ResultType": 1,
 "Granularity": 5,
 "HitType": "reqhitrate"
 }

返回示例

{
  "StartTime": "2016-07-31T21:14+0800",
  "EndTime": "2016-07-31T21:16+0800",
  "CdnType": "video",
  "DomainIds": "2D09X50,2D09X20",
  "ResultType": 1,
  "Granularity": 5,
  "HitType": "reqhitrate",
  "Datas": [
    {
      "Time": "2016-07-31T21:15+0800",
      "ReqHitRate": 0,
      "Domains": [
        {
          "DomainId": "2D09X20",
          "ReqHitRate": 0
        },
        {
          "DomainId": "2D09X50",
          "ReqHitRate": 0
        }
      ]
    }
  ]
}

金山云,开启您的云计算之旅

立即注册