GetClientRequestData

描述

本接口用于获取域名不同粒度（5分钟、1小时、1天）的统计数据，含flow：流量，单位为 byte；bandwidth：带宽，单位为 bps；request：请求数，单位为次；qps：平均每秒请求次数，单位：次/秒
当粒度为1小时或者1天时，带宽取该粒度范围内所含5分钟点的最大峰值点
统计方式：按照client IP归属来进行统计
支持查询最近一年内，最大跨度为90天的数据（不同粒度支持查询跨度不一样）
国内细化数据查询，支持到域名（CdnType/Domain）、区域、省份、运营商、协议类型、IP类型、粒度的多维度数据查询
单次查询总返回数据点不超过10000个，域名数量不得超过1000个，且单次查询时间跨度至少包含一个时间粒度点（如，粒度为5分钟的时候，单次查询起止时间应大于等于五分钟)

请求语法

本接口请求需要包含指定目录/V3/GetClientRequestData和公共请求header和该接口所特有的请求参数，具体请求语句参照下文请求示例。

请求参数

参数名	必选	类型及范围	说明
StartTime	是	String	获取数据起始时间点，日期格式按ISO8601表示法，北京时间，格式为：YYYY-MM-DDThh:mm+0800，例如： 2016-08-01T21:10+0800
EndTime	是	String	结束时间需大于起始时间；获取日期格式按照ISO8601表示法，北京时间，格式为：YYYY-MM-DDThh:mm+0800，例如： 2016-08-01T21:15+0800
Metric	否	String	指定查询指标，支持的类型有：flow：流量，单位为 byte；bandwidth：带宽，单位为 bps；request：请求数，单位为次；qps：平均每秒请求次数，单位：次，支持批量数据查询，多个类型用逗号（半角）分隔，默认为全部类型
Interval	否	Long	统计粒度，取值为 5：5分钟粒度；60：1小时粒度；1440：1天粒度； 5分钟及以上粒度的带宽值均取该粒度时间段内的5分钟粒度的峰值点,流量、请求数取值为求和值。缺省为5分钟粒度。 5分钟粒度查询范围最大跨度为31天，其余粒度查询范围最大跨度为90天
CdnType	是	String	产品类型，只允许输入一种类型，取值为file：大文件下载，video：音视频点播，page：图片小文件；支持多个查询，多个类型用逗号分隔
Domains	否	String	当前账户下选择时间段内正在运行状态的加速域名，可输入需要查询的域名，支持批量域名查询，多个域名用逗号（半角）分隔，缺省为全部域名
Areas	否	String	网民分布区域简称，具体见【使用须知】，支持多区域查询，多个区域用逗号（半角）分隔，缺省为全部区域
Provinces	否	String	省份区域名称，枚举类型表见【使用须知】；支持省份批量查询，多个省份用逗号（半角）分隔，缺省为全部省份（当Areas选项有且仅有中国大陆选项时，此类型生效，且支持数据展开），具体Provinces见下附录说明
Isps	否	String	运营商名称，枚举类型表见【使用须知】；只允许输入一种类型，缺省为全部运营商，（当Areas选项有且仅有中国大陆选项时，此类型生效，且支持数据展开），具体ISP见下附录说明
IpType	否	String	IP类型，取值为ipv4:ipv4类型数据;ipv6:ipv类型数据；单选，缺省为全部IP类型
Schema	否	String	协议类型，取值为http:http协议数据; https:https协议数据；quic：quic协议数据，单选，缺省为全部协议类型
ResultType	否	String	统计结果数据展示方式，支持不展开和展开，缺省为不展开（unexpand）数据展开支持全部展开（expand）和按照指定查询维度展开，包含：域名（domain）、区域、省份（province）、运营商（isp）、IP类型（ip）、协议类型（schema）支持多个条件组合展开，多个条件之间用半角逗号区分开来 —— PS:此处一共有31种组合数据包含关系如下：域名 > 省份 > 运营商 > IP 类型 > 协议类型

返回参数

参数名	类型及范围	说明
StartTime	String	开始时间
EndTime	String	结束时间
Metric	String	本次查询指标
Interval	Long	粒度
CdnType	String	产品类型
Domains	String	域名列表，逗号（半角）间隔
Areas	String	区域，逗号（半角）间隔，枚举类型表见使用须知
Provinces	String	省份区域，枚举类型表见使用须知
Isps	String	运营商，枚举类型表见使用须知
IpType	String	IP类型
Schema	String	协议类型
ResultType	String	是否展开，以及展开的维度，多个维度用逗号（半角）间隔
Datas	Datas[]	不同条件下的统计数据
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

Datas

参数名	类型及范围	说明
Condition	Condition[]	查询条件
Data	Data[]	查询数据

Condition

参数名	类型及范围	说明
参数名	类型及范围	说明
Domains	String	域名列表，逗号（半角）间隔
Areas	String	区域，逗号（半角）间隔
Provinces	String	省份区域，按查询条件展示，无此条件，则不展示
Isps	String	运营商，按查询条件展示，无此条件，则不展示
IpType	String	IP类型，按查询条件展示，无此条件，则不展示
Schema	String	协议类型，按查询条件展示，无此条件，则不展示

Data

参数名	类型及范围	说明
Time	String	时间点
Bandwidth	Long	对应时间点带宽峰值，按查询条件展示，无此条件，则不展示
Flow	Long	对应时间点流量，按查询条件展示，无此条件，则不展示
Request	Long	对应时间点请求数，按查询条件展示，无此条件，则不展示
Qps	Double	对应时间点 QPS，按查询条件展示，无此条件，则不展示

示例

请求示例

GET方式：

GET /V3/GetClientRequestData?StartTime=2020-09-01T08%3a00%2b0800&EndTime=2020-09-01T08%3a05%2b0800&Metric=flow&Interval=5&CdnType=video&Areas=CN&Provinces=beijing&Isps=&IpType=&Schema=&ResultType=
Host: cdn.api.ksyun.com
X-Amz-Date: date
Authorization:authorization string
x-action: GetClientRequestData
x-version: V3

POST方式：

POST /V3/GetClientRequestData
Host: cdn.api.ksyun.com
X-Amz-Date: date
Authorization:authorization string
x-action: GetClientRequestData
x-version: V3
Content-Type: application/json
{
    "StartTime": "2020-09-01T08:00+0800",
    "EndTime": "2020-09-01T08:05+0800",
    "Metric":"flow",
    "Interval":"5",
    "CdnType":"video",
    "Areas": "CN",
    "Provinces": "beijing",
    "Isps": "",
    "IpType": "",
    "Schema": "",
    "ResultType": ""
}

返回示例

{
    "StartTime": "2020-09-01T08:00+0800",
    "EndTime": "2020-09-01T08:05+0800",
    "Metric": "flow",
    "Interval": 5,
    "CdnType": "video",
    "Domains": "www.test.com",
    "Areas": "CN",
    "Provinces": "beijing",
    "Isps": "PBS,CT,CTT,CE,UN,CM,Other",
    "IpType": "ipv4,ipv6",
    "Schema": "http,https,quic",
    "ResultType": "unexpand",
    "Datas": [
        {
            "Condition": {},
            "Data": [
                {
                    "Time": "2020-09-01T08:00+0800",
                    "Flow": 0.0
                }
            ]
        }
    ],
    "RequestId": "7f9c419a-3f57-433b-8399-a9fcb68c8d8e"
}

文档导读

上一篇：01_资源监控

下一篇：服务数据查询

纯净模式常规模式

纯净模式

点击可全屏预览文档内容