通過API管理,可以快速對所屬服務專案的API進行限流和警示設定。本文為您介紹如何對API進行限流和警示配置。
使用限制
當開啟了資料服務高可用模組,服務的限流規則僅影響主鏈路,備鏈路不受影響。
API在開發環境下不支援警示配置。
若API的調用模式從同步調用切換為非同步呼叫,則針對平均調用時間長度的監控警示規則不生效;若警示規則未變更且從非同步呼叫切換為同步調用,則相應的警示規則仍然生效。
許可權說明
超級管理員、專案系統管理員、營運人員支援配置API的限流和警示。
限流設定
在Dataphin首頁的頂部功能表列,選擇服務 > API營運。
單擊左側導覽列的限流&警示,在API營運頁面,單擊目標API操作列下的限流。
在API限流配置對話方塊中,配置參數。
參數
描述
限流狀態
選擇開啟或關閉限流狀態。
單位時間
選擇限流的單位,當網路設定為內建網關時僅支援選擇sec。
單位時間
選擇限流的單位,當網路設定為阿里雲API Gateway時支援選擇sec、min、hour、day。
API流量限制
填寫API限流的資料。例如,企業所購買的總流量為每秒查詢率是500,如果單位時間選擇sec,則API流量限制填寫的資料應該小於等於500。
APP流量限制
填寫API的下遊App的流量控制。填寫App流量限制的規則:
App流量限制對API下的所有App生效。
App流量限制必須小於等於API流量限制。
API流量限制的優先順序大於App流量限制。例如,API流量限制為每秒查詢率是1000,App1的流量限制為每秒查詢率是500,App2的流量限制為每秒查詢率是500,App3的流量限制為每秒查詢率是500,各App流量限制的總和大於API的流量限制,但流量限制的上限為API流量限制。
當App流量限制大於API流量限制時,系統會給出報錯資訊。
添加App
單擊添加App,配置應用、限流次數。填寫限流次數的規則:
特殊App的限流次數必須小於等於API流量限制。
特殊App的限流次數大於API流量限制時,系統會給出報錯資訊。
單擊確定,完成API限流的配置。
如果一個時間視窗內的請求達到限制速率,則系統通過排隊、等待或降級等方式,來保護系統。
警示設定
在API營運頁面,單擊目標API操作列下的警示。
在API警示頁面,配置API警示資訊。
參數
描述
監控指標
選擇警示規則的API監控指標。監控指標包括:
調用次數:在指定時間內,調用API的總次數。
錯誤率:在指定時間內,API調用錯誤總次數/API調用總次數。
平均調用時間長度:僅同步調用支援該監控指標。在指定時間內,API調用總時間長度/API調用總次數。
單位時間
選擇API調用的單位時間。單位時間包括1min 、5min、10min、30min、60min。
操作符
選擇監控指標與觸發閾值的比較的操作符。操作符包括=,>=,<=, <,>, !=。
觸發閾值
填寫警示規則的觸發閾值。
通知方式
選擇警示語音總機的方式。
通知人
選擇警示資訊的接收人。
靜默期
在短時間內多次警示,可以設定一個靜默期,在發送警示資訊後的靜默期期間,系統不再重複發送相同API警示規則的資訊。
狀態
支援開或者關。
單擊確定,完成API的警示配置。
應用調用API運行過程中,如果觸發了監控警示規則,系統會給您發送警示訊息,便於您及時發現並處理異常。