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

您目前查看的是 Apigee Edge 說明文件。
參閱 Apigee X 說明文件。 資訊

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

大多數 API Proxy 都會強制執行配額，配額可讓您控制用戶端應用程式在指定時間間隔內叫用 API 的頻率。在以下範例中，配額政策設為限制應用程式每分鐘只能發出 1 次要求。(雖然可能不太實際，但使用者可以透過簡單的方式瞭解政策成效)。

在 API Proxy 設定中，政策檔案會以 XML 檔案的形式儲存在 /apiproxy/policies 目錄下。

舉例來說，您可以將名為「QuotaPolicy」的配額類型政策建立為名為 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 服務為 API 強制執行的設定。其他政策類型可定義自己的設定。詳情請參閱政策參考資料。