PythonScript ポリシー

概要

Python Script ポリシーを使用すると、カスタマイズした Python 機能を API プロキシフローに追加できます。これは、Edge の既定ポリシーで提供される機能では足りない場合に便利です。

Python の言語サポートは Jython バージョン 2.5.2 を通じて提供されます。サードパーティ ライブラリを追加する場合は、純粋な Python にする必要があります(Python でのみ実装される必要があります)。ライブラリの追加の詳細については、リソース ファイルをご覧ください。

Python ポリシーには実際のコードを記述しません。Python ポリシーでは、Python リソースを参照し、Python スクリプトを実行する API フローのステップを定義します。Management UI のプロキシ エディタを通じてスクリプトをアップロードするか、ローカルで開発している API プロキシの /resources/py ディレクトリにスクリプトを含めることができます。

サンプル

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>

この例では、関連する Python スクリプト リソースを ResourceURL 要素に指定しています。

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 文字を超えることはできません。

管理 UI プロキシ エディタで <DisplayName> 要素を追加して、ポリシーのラベルに使用する別の自然言語名を指定することもできます。

なし 必須
continueOnError

ポリシーが失敗したときにエラーを返す場合は、false に設定します。これは、ほとんどのポリシーで想定される動作です。

ポリシーが失敗した後もフローの実行を続行する場合は、true に設定します。

false 任意
enabled

ポリシーを適用するには、true に設定します。

ポリシーを無効にするには、false に設定します。ポリシーがフローに接続されている場合でも適用されません。

true 任意
async

この属性は非推奨となりました。

false 非推奨

<DisplayName> 要素

管理 UI プロキシ エディタで name 属性と一緒に使用して、ポリシーのラベルに使用する自然言語名を指定します。

<DisplayName>Policy Display Name</DisplayName>
デフォルト

なし

この要素を省略した場合、ポリシーの name 属性の値が使用されます。

要否 任意
種類 文字列

<ResourceURL> 要素

この要素には、API フローで実行されるメインの Python ファイルを指定します。このファイルを API プロキシ スコープ(API プロキシ バンドルの /apiproxy/resources/py の下、あるいは API プロキシ エディタのナビゲーション パネルの [スクリプト] セクション)で、あるいは組織または環境スコープで保存して、複数の API プロキシ間で再使用できます。詳しくは、リソース ファイルの説明をご覧ください。コードでは、JavaScript オブジェクト モデルのオブジェクト、メソッド、プロパティを使用できます。

<ResourceURL>py://myscript.py</ResourceURL>
デフォルト: なし
要否: 必須
型: 文字列

<IncludeURL> 要素

<ResourceURL> 要素で指定されたメインの Python ファイルに依存関係として読み込ませる Python ファイルを指定します。このスクリプトは、ポリシーに指定した順番で評価されます。

複数の <IncludeURL> 要素を使用して複数の Python 依存関係を含めることができます。

<IncludeURL>py://myscript_dependency.py</IncludeURL>
デフォルト: なし
要否: 省略可
型: 文字列

エラーコード

このセクションでは、このポリシーによってエラーがトリガーされたときに返される障害コードとエラー メッセージ、Edge によって設定される障害変数について説明します。これは、障害に対処する障害ルールを作成するうえで重要な情報です。詳細については、ポリシーエラーについて知っておくべきこと障害の処理をご覧ください。

ランタイム エラー

このエラーは、ポリシーの実行時に発生することがあります。

障害コード HTTP ステータス 原因 解決方法
steps.script.ScriptEvaluationFailed 500 PythonScript ポリシーは、複数のタイプの ScriptExecutionFailed エラーをスローします。よくあるエラーとしては、NameErrorZeroDivisionError があります。

デプロイエラー

以下のエラーは、このポリシーを含むプロキシをデプロイするときに発生することがあります。

エラー名 原因 解決方法
InvalidResourceUrlFormat PythonScript ポリシーの <ResourceURL> または <IncludeURL> 要素で指定されたリソース URL の形式が無効な場合、API プロキシのデプロイが失敗します。
InvalidResourceUrlReference <ResourceURL> 要素または <IncludeURL> 要素が存在しない PythonScript ファイルを参照している場合、API プロキシのデプロイが失敗します。参照先のソースファイルが API プロキシ、環境、組織レベルのいずれかに存在している必要があります。

障害変数

次の変数は、このポリシーでランタイム エラーが発生したときに設定されます。詳細については、ポリシーエラーについて知っておくべきことをご覧ください。

変数 説明
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>

関連トピック