PythonScript 政策

查看 Apigee Edge 說明文件。
前往 Apigee X說明文件。 資訊

結果

Python Script 政策可讓您將自訂的 Python 功能新增至 API Proxy 流程。 尤其是您需要的功能超出 Edge 立即可用的政策時 因此，使用 Kubernetes Engine 即可。

Python 語言支援透過 Jython 提供 2.5.2 版。您新增的第三方程式庫必須是「純 Python」(僅以 Python 實作)。 如要進一步瞭解如何新增程式庫，請參閱「資源檔案」。

Python 政策不含任何實際程式碼。而是會參照 Python 政策 資源，並定義執行 Python 指令碼時在 API 流程中的步驟。您可以上傳 撰寫指令碼的「管理」使用者介面 Proxy 編輯器，或是直接在 /resources/py 目錄 (位於本機開發的 API Proxy 中)。

範例

Python 政策和指令碼

Python Script 政策

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Script name="Python-1">
        <DisplayName>Python-1</DisplayName>
        <ResourceURL>py://myscript.py</ResourceURL>
</Script>

在此範例中，元素 ResourceURL 指定了相關的 Python 指令碼 資源。

Python 指令碼

這張圖片顯示了您可能會在 Python 指令碼中加入的內容。

import base64

username = flow.getVariable("request.formparam.client_id")
password = flow.getVariable("request.formparam.client_secret")

base64string = base64.encodestring('%s:%s' % (username, password))[:-1]
authorization = "Basic "+base64string

flow.setVariable("authorizationParam",authorization)

元素參照

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Script name="Python-1">
    <DisplayName>Python-1</DisplayName>
    <ResourceURL>py://myscript.py</ResourceURL>
    <IncludeURL>py://myscript_dependency.py</IncludeURL>
</Script>

下表說明所有政策父項元素的共同屬性：

屬性 說明 預設 存在必要性
name

政策的內部名稱。name 屬性的值可以 包含英文字母、數字、空格、連字號、底線和半形句號。此值不能 超過 255 個半形字元

視需要使用 <DisplayName> 元素，為政策加上標籤： 管理使用者介面 Proxy 編輯器，使用不同的自然語言名稱。

 不適用 必填
continueOnError

如果設為「false」，系統會在政策失敗時傳回錯誤。這是可預期的情況 大多數政策的行為

如果設為 true，即使政策已發生，流程執行作業仍會繼續執行 失敗。

 false 選用
enabled

如要強制執行政策，請設為 true。

設為 false 即可停用政策。這項政策不會 仍會強制執行 政策。

 true 選用
async

此屬性已淘汰。

 false 已淘汰

&lt;DisplayName&gt;元素

除 name 屬性外，一併使用 管理 UI Proxy 編輯器，使用不同的自然語言名稱。

<DisplayName>Policy Display Name</DisplayName>
預設

不適用

如果省略這個元素，政策的 name 屬性值會是

存在必要性 選用
類型 字串

&lt;ResourceURL&gt; 元素

這個元素會指定將在 API 流程中執行的主要 Python 檔案。您可以儲存 位於 API Proxy 範圍的檔案 (在 API Proxy 的 /apiproxy/resources/py 下) API Proxy 編輯器「Navigator」窗格的「Scripts」部分，或是在 可以在多個 API Proxy 中重複使用機構或環境範圍，如 「資源檔案」。您的程式碼可使用 JavaScript 物件模型的物件、方法和屬性。

<ResourceURL>py://myscript.py</ResourceURL>
預設： 無
所在地： 必填
類型： 字串

&lt;IncludeURL&gt; 元素

使用 <ResourceURL> 元素。系統會按照 政策中就會列出幾個符號

包含一個以上的 Python 依附元件資源，且具有額外的 <IncludeURL> 元素。

<IncludeURL>py://myscript_dependency.py</IncludeURL>
預設： 無
所在地： 選用
類型： 字串

錯誤代碼

本節說明系統傳回的錯誤代碼和錯誤訊息，以及錯誤變數。 這項政策觸發錯誤時，由 Edge 設定的。請務必瞭解 您必須制定錯誤規則 處理錯誤詳情請參閱這篇文章 瞭解政策錯誤和處理方式 發生錯誤

執行階段錯誤

執行政策時，可能會發生這些錯誤。

錯誤程式碼 HTTP 狀態 原因 修正
steps.script.ScriptEvaluationFailed 500 PythonScript 政策可能會擲回數種不同類型的 ScriptExecutionFailed 錯誤。經常 常見的錯誤類型包括 NameError 和 ZeroDivisionError。

部署錯誤

當您部署含有這項政策的 Proxy 時，可能會發生這些錯誤。

錯誤名稱 原因 修正
InvalidResourceUrlFormat 如果 <ResourceURL> 中指定的資源網址格式或 PythonScript 政策的 <IncludeURL> 元素無效，表示 API Proxy 的部署失敗。
InvalidResourceUrlReference 如果 <ResourceURL> 或 <IncludeURL> 元素 參照不存在的 PythonScript 檔案，API Proxy 的部署就會失敗。 參照的來源檔案必須存在 API Proxy、環境或機構層級。

錯誤變數

當這項政策在執行階段觸發錯誤時，即可設定這些變數。如需更多資訊 見你什麼 需要瞭解政策錯誤

變數 地點 範例
fault.name="fault_name" fault_name 是錯誤的名稱，如上方「執行階段錯誤」表格所列。 錯誤名稱是錯誤程式碼的最後部分。 fault.name Matches "ScriptExecutionFailed"
pythonscript.policy_name.failed policy_name 是使用者指定錯誤的政策名稱。 pythonscript.PythonScript-1.failed = true

錯誤回應範例

{
  "fault": {
    "faultstring": "Execution of SetResponse failed with error: Pythonscript runtime error: "ReferenceError: "status" is not defined.\"",
    "detail": {
      "errorcode": "steps.script.ScriptExecutionFailed"
    }
  }
}

錯誤規則範例

<FaultRule name="PythonScript Policy Faults">
    <Step>
        <Name>AM-CustomErrorResponse</Name>
        <Condition>(fault.name Matches "ScriptExecutionFailed") </Condition>
    </Step>
    <Condition>(pythonscript.PythonScript-1.failed = true) </Condition>
</FaultRule>

相關主題