接口描述:调用本接口可同时查询多个统计指标,包含请求数,请求命中率,QPS,流量,命中流量,流量命中率,带宽
请求方式:post
请求路径:/statistics/query-summary-data
使用说明:
- 单个用户一分钟限制调用10000次,并发不超过100;
- 单次查询输入域名的个数不能超过100个;
- 时间粒度为24h时,查询开始时间与结束时间需要跨天,否则查询的数据为空;
- 最大返回记录50000条记录;
- 若查询结束时间不包含在该批次的最后一秒,默认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。
时间粒度 | 可查询历史数据时间范围 | 数据延迟 | 单次可查询的时间跨度 |
---|---|---|---|
1m | 最近7天 | 5分钟 | 1小时 |
5m | 最近186天 | 20分钟 | 5小时 |
1h | 最近186天 | 20分钟 | 1天 |
24h | 最近186天 | 20分钟 | 31天 |
请求参数说明(json):
参数 | 类型 | 是否必传 | 名称 | 描述 |
---|---|---|---|---|
start_time | int | 是 | 开始时间戳 | 起始时间,时间戳(秒)。 |
end_time | int | 是 | 结束时间戳 | 结束时间,时间戳(秒)。 |
interval | string | 否 | 时间粒度 | 时间粒度,目前支持1m,5m,1h和24h,默认5m。 |
product_type | string | 是 | 产品类型 | “006”(全站加速) |
busi_type | list< int > | 否 | 业务类型 | base(0),upload(1),websocket(2),不传默认所有业务类型 |
domain | string | 否 | 域名 | 域名,仅支持单个域名,作为统计筛选项,不传默认名下所有域名。 |
province | list< int > | 否 | 省编码列表 | 省编码,不传默认所有省份,可多个省编码,作为统计筛选项,点击查看地区及省份列表。 |
isp | list< string > | 否 | 运营商编码列表 | 运营商编码,不传默认所有运营商,可多个运营商编码,作为统计筛选项,点击查看运营商列表。 |
network_layer_protocol | string | 否 | 网络层协议 | 网络层协议,不传默认所有网络层协议,支持作为统计筛选项,可以为ipv4、ipv6,other。 |
application_layer_protocol | string | 否 | 应用层协议 | 应用层协议,不传默认所有应用层协议,支持作为统计筛选项,可以为http,https,rtmp,quic,other。 |
abroad | int | 否 | 区域 | 区域,国内(0),国外(1),不传或为空默认返回全部区域 |
group_by | string | 否 | 结果聚合维度 | 指标在计算结果的聚合维度,不传或为空默认按照时间粒度聚合,支持busi_type,province,isp,network_layer_protocol,application_layer_protocol,abroad,仅支持增加单个结果聚合维度。 |
返回参数说明:
参数 | 类型 | 是否必传 | 名称及描述 |
---|---|---|---|
code | int | 是 | 状态码 |
message | string | 是 | 描述信息 |
start_time | int | 否 | 开始时间戳,时间戳(秒) |
end_time | int | 否 | 结束时间戳,时间戳(秒) |
interval | string | 否 | 时间粒度 |
req_summary_data_interval | list< object > | 否 | 每个时间间隔的带宽数据 |
req_summary_data_interval[*].time_stamp | int | 否 | 时间片开始时间戳 |
req_summary_data_interval[*].busi_type | int | 否 | 业务类型,base(0),upload(1),websocket(2) |
req_summary_data_interval[*].province | int | 否 | 省编码 |
req_summary_data_interval[*].isp | string | 否 | 运营商编码 |
req_summary_data_interval[*].network_layer_protocol | string | 否 | 网络层协议:ipv4、ipv6,other |
req_summary_data_interval[*].application_layer_protocol | string | 否 | 应用层协议:http,https,rtmp,quic,other |
req_summary_data_interval[*].abroad | int | 否 | 区域,国内(0),国外(1) |
req_summary_data_interval[*].request_num | int | 否 | 请求数 |
req_summary_data_interval[*].hit_request_rate | float | 否 | 请求命中率,当请求参数product_code传参为"006"(全站加速)且busi_type为2(websocket)时,不返回 |
req_summary_data_interval[*].qps | float | 否 | QPS,单位:次/每秒 |
req_summary_data_interval[*].hit_flow_rate | float | 否 | 流量命中率,当请求参数product_code传参为"006"(全站加速)时且busi_type为2(websocket),不返回 |
req_summary_data_interval[*].flow | long | 否 | 流量,单位Byte |
req_summary_data_interval[*].hit_flow | long | 否 | 命中流量,单位Byte,当请求参数product_code传参为"006"(全站加速)且busi_type为2(websocket)时,不返回 |
req_summary_data_interval[*].bandwidth | float | 否 | 带宽,单位bit/s(bps) |
示例:
请求路径:https://cdnapi-global.ctapi.ctyun.cn/statistics/query-summary-data
请求参数:
{
"start_time": 1662413100,
"end_time": 1662413700,
"product_type":"006",
"domain": [
"aaa.ctyun.cn",
"bbb.ctyun.cn"
],
"group_by": "application_layer_protocol"
}
返回结果:
{
"code": 100000,
"message": "success",
"start_time": 1662413100,
"end_time": 1662413700,
"interval": "5m",
"req_summary_data_interval": [
{
"time_stamp": 1662413100,
"application_layer_protocol": "https",
"request_num": 178874,
"hit_request_rate": 96.34,
"qps": 59.58,
"hit_flow_rate": 98.47,
"flow": 21009529728,
"hit_flow": 20687073220,
"bandwidth": 560254126.08
},
{
"time_stamp": 18598418934,
"application_layer_protocol": "http",
"request_num": 178874,
"hit_request_rate": 96.34,
"qps": 59.58,
"hit_flow_rate": 98.47,
"flow": 21009529728,
"hit_flow": 20687073220,
"bandwidth": 560254126.08
}
]
}
错误码请参考:参数code和message含义