功能介绍
API自发现功能能够帮助用户从访问日志中自动发现API接口的请求,并生成API资产,无需用户手动新增。
注意
已订购API安全扩展服务的用户,支持不限次数使用API自发现功能。
未订购API安全扩展服务的用户,提供有限次数的免费API自发现功能体验,一旦点击“开始”则消耗一次体验机会。
前提条件
操作步骤
- 登录边缘安全加速平台控制台。
- 在左侧导航栏中选择【安全能力】,进入【API安全】菜单,并在左侧域名列表选择您要防护的域名。
- 在API资产列表右侧,点击【资产管理】按钮,进行API资产管理页面。
- 在【API资产列表】左上方,点击【API自发现】。
开始API自发现
开始API自发现任务,需要指定自发现域名、自发现时间范围、自发现标签及标记效果。平台将按照自发现开始时间,对域名的全量请求、响应报文进行分析,直到自发现结束时间到达后停止分析,并自动生成API资产。针对本次任务发现的API,还会在自发现标签打上对应标签,方便用户识别。
配置项 | 是否必填 | 说明 |
---|---|---|
域名 | 是 | 指定需要进行API自发现的域名。 |
自发现时间范围 | 是 | 配置自发现的开始时间和结束时间。 自发现时间范围须为晚于当前时间。 自发现时间范围最大跨度为10天。 |
自发现标签 | 否 | 针对本次自发现的API接口打上自发现标签,方便用户识别自发现结果。 标记内容可自定义或从已配置的标签内容中选择,自定义配置的标签内容会自动加入自定义标签。 如无需打标签,可不配置。 标签管理详见API标签管理。 |
标记效果 | 否 | 若本次自发现的API资产已经存在且已标记API自发现标签,那么本次自发现会再次对该API资产打上自发现标签,用户可选择标记效果。 覆盖:将API已存在的自发现标签清除,标记所配置的标签内容。 叠加:在原来自发现标签的基础上,增加所配置的标签内容。 |
注意未订购API安全扩展服务的用户,单次配置API自发现只能选择一个域名。已订购API扩展服务的用户,单次配置API自发现可选择多个域名,单次最多选择10个。
结束API自发现
当API自发现任务下发之后,自发现结束时间未到达之前,用户再次点击【API自发现】按钮,可手动结束API自发现任务。
说明结束API自发现,即停止API自发现任务,同时基于自发现开始时间至手动结束时间范围,生成API自发现结果。
放弃API自发现
当API自发现任务下发之后,自发现结束时间未到达之前,用户再次点击【API自发现】按钮,可放弃本次自发现任务。
说明放弃API自发现,即停止API自发现任务,并且不生成API自发现结果。