基于CDNetworks定义的API识别模型,实时检测请求侧以及响应侧的请求特征,并自动聚合API并提取接口样式。同时,对每一个API的请求趋势、响应状态码、请求方法等数据进行分析统计,并自动识别参数资产。最终提供从API资产列表到参数资产列表的完整资产清单。
功能启停
开始发现:启用API发现功能。启用功能后开始分析检测流量中的API特征数据。若保持功能启用状态,将定时更新API资产最新发现结果(每半小时更新一次)。
首次启用API发现功能需要一定时间进行学习。对于具有强API特征的接口,在启用半小时后即可观测到资产识别结果;对于疑似API,需要5天的历史流量日志支撑学习。
停止发现:停止API发现功能。停止功能后历史发现的API资产将被保留,在重新启用API发现功能时即可直接查看。
API资产列表
查询条件
支持域名粒度与API前端路径的查询,其中端点路径支持多关键字模糊搜索。
API列表信息
支持查看自动发现的API资产的域名、端点路径、首次发现时间、更新时间及24h调用量,同时每个API可进一步展开查看请求调用统计信息及请求参数特征。
- 端点路径:展示API端点的调用路径。针对包含路径参数的端点路径,分析引擎会进行API路径规范化与聚合,自动提炼路径参数,并按照聚合后的路径进行展示。
- 首次发现时间:流量数据中第一次识别并确定此路径为API的时间。
- 最新发现时间:此API在流量数据中最新一次活跃的时间。
- 24h调用量:距当前时间前24h的API请求次数。
- 定义状态:
- 已定义:已在“API定义”中存在的API。
- 未定义:未在“API定义”中存在的API。
- 操作:
- 创建API:点击将跳转至新增API配置页,并将域名、端点路径等基础信息自动带入,快速将发现的API添加至API定义中。
- 错误上报:可将非API资产上报,上报的API将在API发现中移除。
API详情信息
点击API列表中每条API前方的展开/收缩按钮即可查看/收起API的统计分析数据详情。
- 调用概况:针对每一个发现的API进行请求趋势、响应状态码、可调用的请求方法等数据进行分析统计。
- 调用情况:支持查看发现与更新时间,及该API近30天内的调用趋势。
- 请求方法:支持查看该API近30天内请求方法的调用次数及占比。
- 响应码:支持查看该API近30日内状态码的响应次数及占比。
- 请求参数特征:针对每一个发现的API深入分析其参数资产列表。参数资产识别范围涵盖Query String参数、Cookie参数、Http Header参数和请求Body参数。其中当请求Body为JSON格式时,支持识别参数对应的JSON模板及嵌套层级。