接口描述:调用本接口查询流量,命中流量,流量命中率,回源流量数据
请求方式:post
请求路径:/statistics/query-flow-data
使用说明:
单个用户一分钟限制调用10000次,并发不超过100;
单次查询输入域名的个数不能超过100个;
单次查询输入结果聚合维度(group_by)的个数不能超过4个;
时间粒度为24h时,查询开始时间与结束时间需要跨天;
若查询结束时间不包含在该批次的最后一秒,默认end_time为该批次最后一秒,例如:时间粒度为1h,end_time设置为17:30对应的时间戳,此时end_time默认成17:59:59;
时间片统计数据均为前打点,假如请求5分钟粒度数据,time_stamp= "2021-10-13 00:00"对应的时间戳,表示统计的数据为时间区间[2021-10-13 00:00, 2021-10-13 00:05);
根据请求参数时间粒度(Interval)和聚合维度(group_by)个数的不同,单次请求可查询历史数据范围,数据延迟,对应如下, 若开始时间超过可查询历史数据时间范围,超过部分的数据为0;
时间粒度 | 可查询历史数据时间范围 | 数据延迟 | 2 ≥ 聚合维度个数 ≥ 0 ,支持最大时间跨度 | 4 ≥ 聚合维度个数 >2 支持最大的时间跨度 |
---|---|---|---|---|
1m | 最近31天 | 5分钟 | 7天 | 3小时 |
5m | 最近183天 | 20分钟 | 31天 | 1天 |
1h | 最近183天 | 20分钟 | 93天 | 3天 |
24h | 最近183天 | 20分钟 | 93天 | 3天 |
请求参数说明(json):
参数 | 类型 | 是否必传 | 名称 | 描述 |
---|---|---|---|---|
start_time | int | 是 | 开始时间戳 | 起始时间,时间戳(秒)。 |
end_time | int | 是 | 结束时间戳 | 结束时间,时间戳(秒)。 |
interval | string | 否 | 时间粒度 | 时间粒度,目前支持1m,5m,1h和24h,默认5m。 |
product_type | List<string> | 否 | 产品类型列表 | 产品类型列表,不传默认名下所有产品,可多个产品类型,作为统计筛选项。支持:“001”(静态加速),“003”(下载加速),“004”(视频点播加速),“008”(CDN加速),“014”(下载加速闲时),“007”(安全加速),“005”(直播加速),“006”(全站加速),“009”(应用加速),“010”(web应用防火墙(边缘云版)),“011”(高防DDoS(边缘云版)) |
domain | list<string> | 否 | 域名列表 | 域名,不传默认名下所有域名,可多个域名,作为统计筛选项。 |
province | list<int> | 否 | 省编码列表 | 省编码,不传默认所有省份,可多个省编码,作为统计筛选项,点击查看省份及对应的省编码 |
isp | list<string> | 否 | 运营商编码列表 | 运营商编码,不传默认所有运营商,可多个运营商编码,作为统计筛选项,点击查看运营商及对应的运营商编码 |
network_layer_protocol | string | 否 | 网络层协议 | 网络层协议,不传默认所有网络层协议,支持作为统计筛选项,可以为ipv4、ipv6,other。 |
application_layer_protocol | string | 否 | 应用层协议 | 应用层协议,不传默认所有络层协议,支持作为统计筛选项,可以为http,https,rtmp,quic,other。 |
group_by | list<string> | 否 | 结果聚合维度 | 指标在计算结果的聚合维度,不传或为空默认按照时间粒度聚合,可多个统计维度,可以为product_type,domain,province,isp,network_layer_protocol,application_layer_protocol。 |
返回参数说明:
参数 | 类型 | 是否必传 | 名称及描述 |
---|---|---|---|
code | int | 是 | 状态码 |
message | string | 是 | 描述信息 |
start_time | int | 是 | 开始时间戳,时间戳(秒) |
end_time | int | 是 | 结束时间戳,时间戳(秒) |
interval | string | 是 | 时间粒度 |
req_hit_flow_rate_data_interval | list<object> | 是 | 每个时间间隔的请求数数据 |
req_hit_flow_rate_data_interval[*].time_stamp | int | 是 | 时间片开始时间戳 |
req_hit_flow_rate_data_interval[*].product_type | string | 否 | 产品类型 |
req_hit_flow_rate_data_interval[*].domain | string | 否 | 域名 |
req_hit_flow_rate_data_interval[*].province | int | 否 | 省编码 |
req_hit_flow_rate_data_interval[*].isp | string | 否 | 运营商编码 |
req_hit_flow_rate_data_interval[*].network_layer_protocol | string | 否 | 网络层协议 |
req_hit_flow_rate_data_interval[*].application_layer_protocol | string | 否 | 应用层协议 |
req_hit_flow_rate_data_interval[*].hit_flow_rate | float | 是 | 流量命中率 |
req_hit_flow_rate_data_interval[*].flow | long | 是 | 流量,单位Byte |
req_hit_flow_rate_data_interval[*].hit_flow | long | 是 | 命中流量,单位Byte |
req_hit_flow_rate_data_interval[*].miss_flow | long | 是 | 回源流量,单位Byte |
示例: 请求路径:https://cdnapi-global.ctapi.ctyun.cn/statistics/query-flow-data 示例1: 请求参数: { "start_time": "1662413100", "end_time": "1662413700", "domain": [ "ctyun.cn", "ctyun.cn1" ], "group_by": [ "application_layer_protocol" ]} 返回结果: { "code": 100000, "message": "success", "start_time": 1662413100, "end_time": 1662413700, "interval": "5m", "req_hit_flow_rate_data_interval": [ { "miss_flow": 322456508, "time_stamp": 1662413100, "hit_flow_rate": 98.47, "application_layer_protocol": "https", "flow": 21009529728, "hit_flow": 20687073220 }, { "miss_flow": 18598418934, "time_stamp": 1662413100, "hit_flow_rate": 97.48, "application_layer_protocol": "http", "flow": 737384513138, "hit_flow": 718786094204 }, { "miss_flow": 18598418934, "time_stamp": 1662413100, "hit_flow_rate": 0, "application_layer_protocol": "other", "flow": 0, "hit_flow": 718786094204 }, { "miss_flow": 342410553, "time_stamp": 1662413400, "hit_flow_rate": 98.38, "application_layer_protocol": "https", "flow": 21123082408, "hit_flow": 20780671855 }, { "miss_flow": 342410553, "time_stamp": 1662413400, "hit_flow_rate": 0, "application_layer_protocol": "other", "flow": 0, "hit_flow": 20780671855 }, { "miss_flow": 15168268047, "time_stamp": 1662413400, "hit_flow_rate": 97.98, "application_layer_protocol": "http", "flow": 750093102472, "hit_flow": 734924834425 }, { "miss_flow": 15350203290, "time_stamp": 1662413700, "hit_flow_rate": 98, "application_layer_protocol": "http", "flow": 769248907279, "hit_flow": 753898703989 }, { "miss_flow": 15350203290, "time_stamp": 1662413700, "hit_flow_rate": 0, "application_layer_protocol": "other", "flow": 0, "hit_flow": 753898703989 }, { "miss_flow": 354166706, "time_stamp": 1662413700, "hit_flow_rate": 98.34, "application_layer_protocol": "https", "flow": 21313762862, "hit_flow": 20959596156 } ]} 示例2: 请求参数: { "start_time": "1662413100", "domain": [ "aaa.com", "bbb.com" ], "group_by": [ "application_layer_protocol" ]} 返回结果: { "code": 100007, "message": "无法找到必须的请求参数:end_time"}