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> 要素

name 属性に加えて、管理 UI プロキシ エディタのポリシーに別のわかりやすい名前でラベルを付けるために使います。

<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>
    
デフォルト: なし
要否: 省略可
型: 文字列

エラーコード

Python Script ポリシーに指定されているエラーコードはありません。

関連トピック