API自动发现主要用于帮助用户自动或半自动发现API资产。
当API资产规模较小时(不超过100条),可选择开启“确认为API资产”,自动将发现的API确认为API资产。
当API资产规模校大时(超过100条),API自动发现任务可发现API资产,用户需进行人工识别和确认后,添加为API资产。
前提条件
已开通Web应用防火墙(原生版)实例企业版或旗舰版。
已完成防护域名接入,并正常防护。
配置API自动发现任务
登录天翼云控制中心。
单击页面顶部的区域选择框,选择区域。
在产品服务列表页,选择“安全 > Web应用防火墙(原生版)”。
在左侧导航栏,选择“API安全 > API管理”,进入API管理页面。
选择“API资产发现”页签,单击“API自动发现”,进入API自动发现任务页面。
在弹出的API自动发现任务页面中,配置任务参数。
任务参数说明如下:
参数 说明 识别范围 通过设置识别范围可限定API的发现范围。单次识别API资产不超过10000个。
支持输入长度为1-256字符,支持通配符,最多可输入10个条件,多个条件之间是或关系。
排除条件 通过设置排除条件排除在识别范围内不属于API的其他路径,从而提升API识别的准确性。
支持输入长度为1-256 字符,支持通配符,最多可输入10个条件,多个条件之间是或关系。
执行周期过期时间 通过设置执行周期过期时间可设置单次任务的运行周期,任务运行最长支持30天,最短支持5分钟。
任务到期或发现API接口超过10000后将自动结束任务。
业务用途识别 开启“业务用途识别”,可基于API接口的路径特征和参数名特征,与自定义的业务用途字段进行匹配,自动判断识别到的API接口业务用途。自定义业务用途请参见新增业务用途规则。
确认为API资产 开启“确认为API资产”,在任务执行结束后,会将本次任务发现的API自动确认为API资产并展示在“API列表”中。
说明
为保证自动确认的资产不产生大量的冗余数据,单次自动确认的资产不超过100条,如果单次自动发现的资产超过100条时,将会将本次任务所有发现的API资产识别为待确认资产。
识别到待确认API资产后 配置API自动发现任务识别到待确认API资产后,对历史待确认API资产的处理方式:
在历史待确认API列表上新增:将识别到的待确认API资产在原有资产上新增。默认选择该方式。
清除历史待确认API资产:清除历史所有待确认API资产,API资产发现列表仅展示本次新发现的待确认API资产。
参数配置完成后,单击“确认”,系统会自动发现从开始任务之后的API接口。
在API识别过程中,发现一个API待确认资产即显示一个,无需在任务执行完成之后再将所有结果添加至待确认列表。
任务执行过程中,可查看任务执行时间、查看任务详情、手动停止任务。
确认API资产
API自动发现任务识别到待确认API资产后,用户手动将其确认为API资产,即可展示在“API列表”中。
说明
确认API时,如果出现相同API,不会重复添加。
登录天翼云控制中心。
单击页面顶部的区域选择框,选择区域。
在产品服务列表页,选择“安全 > Web应用防火墙(原生版)”。
在左侧导航栏,选择“API安全 > API管理”,进入API管理页面,选择“API资产发现”页签。
搜索待确认的API。
在页面左侧,展示了所有防护对象信息(不包括泛域名、ELB防护对象),支持选择“所有防护对象”或选择单个域名站点,在右侧API列表中查看对应防护对象的详细数据列表。
选择“所有防护对象”,页面右侧展示所有待确认的API资产。
选择单个域名站点,页面右侧展示选中的域名站点待确认的API资产。
可通过发现时间、请求方法、业务用途对待确认资产进行筛选。
发现时间:根据API资产最近活跃时间对API资产进行过滤,支持昨天、今天、近3天、近30天,或自定义时间范围。默认选中今天。
请求方法:支持多选。
业务用途:支持多选。
API路径:支持模糊匹配。
搜索定位到目标API后,单击操作列的“确认为API”。
或勾选多个API,单击列表上方的“批量确认”进行批量操作。
在确认为API窗口中,确认API信息,可对API名称、业务用途进行修改。
单击“确认”。
确认为API资产后,API资产将从“API资产发现”页面移动到“API列表”页面中。