您正在查看 Apigee Edge 說明文件。
查看 Apigee X 說明文件。 資訊
將政策型功能新增至 API Proxy 的程序包含兩個步驟:
- 設定政策類型的執行個體。
- 將政策執行個體附加至資料流。
下圖顯示政策與流程之間的關係。如您所見,政策會附加至資料流,做為處理的「步驟」。如要為 API 設定所需的行為,您需要先瞭解流程簡介。(本主題先前在設定流程中已探討)。
廣受歡迎的其中一種政策是 SpikeArrest。SpikeArrest 可避免訊息流量突然增加,以免對後端服務造成負擔。
將政策附加至資料流
如何將政策附加至資料流:
- 選取 API Proxy,然後前往「Develop」(開發) 檢視畫面。
- 在 API Proxy 編輯器中,在「Navigator」窗格中選取要附加政策的流程。
例如,為預設的 API Proxy 端點選取 PreFlow 資料流:
- 在設計檢視畫面中,按一下與要求或回應流程相關聯的「+Step」,附加政策。例如:
「新增步驟」對話方塊隨即開啟,並顯示分類政策清單。
- 捲動並選取要附加至所選流程的政策類型。
- 修改下列欄位。
-
顯示名稱:政策的專屬顯示名稱。UI 會產生預設名稱,但建議您為政策建立描述性名稱。 讓機構中的其他開發人員都能輕鬆瞭解政策的用途。
-
名稱:政策的專屬名稱。這項政策名稱與顯示名稱相符,但有以下例外狀況:
-
空格會由破折號取代。
-
連續破折號會以單破折號取代。
-
除了破折號、底線和空格 (如上所述) 之外,非英數字元的字元 (例如井字號、百分比符號、& 符號等) 會遭到移除。
-
-
- 按一下「新增」。
這項政策已附加至所選流程。
附加政策後,政策會顯示在流程的「Designer」檢視畫面中,在這個範例中,預設 Proxy 端點的 PreFlow 畫面,以及導覽窗格的「Policies」清單中。「Code」檢視畫面會顯示新附加政策的 XML,會顯示在「Designer」檢視畫面下方。邊緣會產生含有一組合理預設值的政策執行個體。
新增政策,但不附加至資料流程
如要新增政策,但不將該政策附加至資料流 (對「處理錯誤」有用),請在「導覽器」+檢視畫面的「政策」+列中,按一下「+」+來開啟「新增政策」+對話方塊,然後新增政策 (如上一節步驟 4 至 6 所述)。
凡是未附加至任何流程的政策,都會在「政策」清單中出現「卸離」圖示,如上圖所示的 API 金鑰訊息政策旁。
建立政策後,您可以將政策從「政策」清單拖曳到「設計人員」檢視畫面中的所需流程,即可將政策附加至流程。
將政策從資料流中卸離
如要將政策從資料流卸離,請選取流程。在流程的「Designer」檢視畫面中,將滑鼠遊標懸停在政策圖示上。按一下圖示中顯示的圓圈中的「X」X。
刪除政策執行個體
如要刪除政策執行個體,請在「Navigator」檢視畫面中,將滑鼠遊標懸停在政策項目上。在項目右側顯示的圓圈中,按一下「X」X。
透過使用者介面設定政策
當 UI 產生政策例項時,會為常用設定套用合理的預設值。您可能需要根據自己的需求修改這些設定。
例如:<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <SpikeArrest async="false" continueOnError="false" enabled="true" name="spikearrest-1"> <DisplayName>SpikeArrest-1</DisplayName> <FaultRules/> <Properties/> <Identifier ref="request.header.some-header-name"/> <MessageWeight ref="request.header.weight"/> <Rate>30ps</Rate> </SpikeArrest>
如要設定政策,請在「Code」檢視畫面中直接編輯政策的 XML 設定。舉例來說,尖峰流量防範政策的尖峰訊息頻率一開始為每秒 30 則訊息。只要變更政策的 XML 中的 <Rate
> 元素值,即可變更峰值率。如要進一步瞭解如何設定政策,請參閱政策參考資料。
您也可以將政策剪下並貼到「Code」檢視畫面。這樣就能同時重複使用 GitHub 上提供的範例政策。
在「Code」檢視畫面中變更政策定義時,變更會反映在「Property Inspector」中。反之亦然,在「Property Inspector」中進行變更,然後顯示在「Code」檢視畫面的 XML 中。
如要查看本主題中使用的配額政策相關說明文件,請參閱配額政策。