在 XML 檔案中附加及設定政策

本頁適用於 Apigee 和 Apigee Hybrid。

查看 Apigee Edge 說明文件。

您可以使用喜愛的文字或 XML 支援編輯器或 IDE，在本機建立及編輯政策。本主題會以配額政策類型做為範例，說明如何建立、設定、附加、部署及測試政策。

大多數 API Proxy 都會強制執行配額。配額可用於控制用戶端應用程式在指定時間間隔內可呼叫 API 的頻率。在下方範例中，我們將配額政策設為限制應用程式每分鐘只能提出 1 次要求。(雖然這可能不切實際，但確實提供了簡單的方式，讓您查看政策的效果)。

在 API 代理程設定中，政策檔案會儲存在 /apiproxy/policies 目錄下，格式為 XML 檔案。

舉例來說，您可以建立名為「Quota Policy」的配額類型政策，並將其設為名為 QuotaPolicy.xml 的檔案，內容如下：

<Quota enabled="true" continueOnError="false" name="QuotaPolicy">
    <Allow count="1"/>
    <Interval>1</Interval>
    <TimeUnit>minute</TimeUnit>
</Quota>

您可以手動建立文字檔，也可以從 XML 結構定義產生政策。所有政策都有一些特定於政策類型的設定，以及一些適用於所有政策的通用設定。

當您在管理 UI 中附加政策時，API Proxy 建構工具會根據您選取的政策類型，從 XML 結構定義產生政策例項。因此，您可能會在政策設定中看到一些元素，這些元素在說明文件中不一定會列出。

所有政策都會定義下列屬性：

  • enabled：指出政策是否已開啟或關閉。您可以變更這項設定，在執行階段啟用/停用政策。將 enabled 設為 false 的政策不會強制執行。
  • continueOnError：定義在政策失敗時，管道是否應繼續處理訊息。在強制執行配額政策時，錯誤可能表示已超出配額，因此應將此屬性設為 false。
  • name：您為此政策命名的名稱。這個名稱是此政策例項的專屬名稱，用於將政策附加至流程，做為處理步驟。

在上述範例中，Allow、Interval 和 TimeUnit 元素皆為配額政策專屬元素。這些元素會提供 API 服務代為強制執行的設定。其他政策類型會定義自己的設定，您可以在政策參考資料中瞭解相關資訊。