PythonScript 政策

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

優勢

Python 指令碼政策可讓您將自訂 Python 功能新增至 API Proxy 流程，尤其是當您需要的功能超出 Edge 立即可用的政策時。

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

Python 政策不含任何實際程式碼。Python 政策會參照 Python 資源，並在執行 Python 指令碼的 API 流程中定義步驟。您可以透過管理 UI Proxy 編輯器上傳指令碼，也可以在在本機開發的 API Proxy 中加入 /resources/py 目錄。

範例

Python 政策與指令碼

Python 指令碼政策

<?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> 元素，在管理 UI Proxy 編輯器中使用不同的自然語言名稱為政策加上標籤。

 不適用 需要
continueOnError

如果設為 false，即可在政策失敗時傳回錯誤。大部分政策都是預期中的行為。

設為 true，即可在政策失敗後繼續執行資料流。

 false 選用
enabled

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

設為 false 即可停用這項政策。即使政策仍附加在流程中，系統也不會強制執行政策。

 true 選用
async

此屬性已淘汰。

 false 已淘汰

<DisplayName> 元素

除了 name 屬性外，您還可以使用不同的自然語言名稱，在管理 UI Proxy 編輯器中為政策加上標籤。

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

不適用

如果省略這個元素，系統會使用政策的 name 屬性值。
存在必要性 選用
類型 字串

<ResourceURL> 元素

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

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

<IncludeURL> 元素

指定要載入的 Python 檔案，做為 <ResourceURL> 元素指定的主要 Python 檔案的依附元件。系統會按照指令碼在政策中列出的順序評估指令碼。

加入多個 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、環境或機構層級。

錯誤變數

當這項政策在執行階段觸發錯誤時，系統會設定這些變數。詳情請參閱「政策錯誤須知」。

Variables 地點 範例
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>

相關主題