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列表”頁面中。