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

本頁內容適用於 ApigeeApigee Hybrid

查看 Apigee Edge 說明文件。

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

大多數 API Proxy 都會強制執行配額。配額可控管用戶端應用程式在特定時間間隔內呼叫 API 的頻率。在下方範例中,配額政策設定為限制應用程式每分鐘只能提出 1 個要求。(雖然這可能不切實際,但確實提供簡單的方法來查看政策的影響。)

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

舉例來說,您可以建立名為 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:您為這項政策指定的名稱。這個名稱是此政策執行個體的專屬名稱,用於將政策附加至流程做為處理步驟。

在上述範例中,AllowIntervalTimeUnit 元素是配額政策專屬的元素。這些元素提供的設定會由 API 服務代表 API 強制執行。其他政策類型會定義自己的設定,詳情請參閱政策參考資料