全部文档
当前文档

暂无内容

如果没有找到您期望的内容,请尝试其他搜索词

文档中心

查询命中率

最近更新时间:2024-03-27 15:08:36

查询命中率(GetHitRateData

接口描述

本接口用于获取域名某一时间段内流量命中率、请求数命中率数据,用于绘制命中率饼图

  • 支持按指定的起止时间查询,两者需要同时指定

  • 支持批量域名查询,多个域名ID用逗号(半角)分隔

  • 最多可获取最近一年内93天跨度的数据

  • 时效性:5分钟延迟

  • 单次查询域名数量不得超过1000个,且单次查询时间跨度至少包含一个时间粒度点(如,粒度为5分钟的时候,单次查询起止时间应大于等于五分钟)。

  • 使用场景:

    • 客户查询单个域名或多域名合并后在某一时间段内实时命中率求和数据,用于绘制命中率饼图

  • 说明:

    • Hit访问次数=服务请求数-回源请求数

    • Miss访问次数=回源请求数

    • Hit访问流量=服务流量-回源流量

    • Miss访问流量=回源流量

  • 签名机制

    • Service取值:cdn

  • 接入地址:cdn.api.ksyun.com︎

请求语法

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

请求参数

参数名

类型

是否必须

描述

StartTime

String

Y

获取数据起始时间点,日期格式按ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如: 2016-08-01T21:14+0800

EndTime

String

Y

结束时间需大于起始时间;获取日期格式按照ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如: 2016-08-01T21:14+0800

CdnType

String

Y

产品类型,live:流媒体直播

DomainIds

String

N

域名ID,缺省为当前产品类型下的全部域名,可输入需要查询的域名ID,支持批量域名查询,多个域名ID用逗号(半角)分隔

返回参数

参数名

类型

描述

StartTime

String

开始时间

EndTime

String

结束时间

CdnType

String

产品类型

DomainIds

String

域名ID列表,逗号(半角)间隔

Datas

HitRateData[]

所选时间段内命中百分占比数据

HitRateData

参数

类型

描述

HitPv

Long

Hit状态的访问次数,即服务请求数-回源请求数

MissPv

Long

Miss状态的访问次数,即回源请求数

HitPvProportion

Double

Hit状态访问次数占比,即HitPv/(HitPv+MissPv)

MissPvProportion

Double

Miss状态访问次数占比,即SrcPv/(HitPv+MissPv)

HitFlow

Long

Hit状态的访问流量,即服务流量-回源流量

MissFlow

Long

Miss状态的访问流量,即回源流量

HitFlowProportion

Double

Hit状态访问流量占比,即HitFlow/(HitFlow+MissFlow)

MissFlowProportion

Double

Miss状态访问流量占比,即MissFlow/(HitFlow+MissFlow)

请求示例

GET方式:

GET /2016-09-01/statistics/GetHitRateData?DomainIds=2D08X0G&StartTime=2019-05-06T00%3A00%2B0800&EndTime=2019-05-15T00%3A15%2B0800&CdnType=live 1.1
Host: cdn.api.ksyun.com
X-Amz-Date: date
Authorization: authorization string
x-action: GetPvData
x-version: 2016-09-01

POST方式:

POST  /2016-09-01/statistics/GetHitRateData 1.1
Host: cdn.api.ksyun.com
X-Amz-Date: date
Authorization: authorization string
x-action: GetHitRateData
x-version: 2016-09-01
Content-Type: application/json

{
    "DomainIds": "2D08X0G",
    "StartTime": "2019-05-06T00:00+0800",
    "EndTime": "2019-05-15T00:15+0800",
    "CdnType": "live"
}

返回示例

{
    "StartTime": "2019-05-06T00:00+0800",
    "EndTime": "2019-05-15T00:15+0800",
    "DomainIds": "2D08X0G",
    "CdnType": "live",
    "Datas": [
        {
            "HitPv": 0,
            "MissPv": 0,
            "HitPvProportion": 0.0,
            "MissPvProportion": 100.0,
            "HitFlow": 0,
            "MissFlow": 0,
            "HitFlowProportion": 0.0,
            "MissFlowProportion": 100.0
        }
    ]
}

错误码

此接口为CDN接口,请到使用须知查看错误码详情。

文档导读
纯净模式常规模式

纯净模式

点击可全屏预览文档内容
文档反馈