共有フローバンドル構成リファレンス

Apigee X のドキュメントが表示されています。
Apigee Edge のドキュメントを表示する。

共有フローは、API プロキシと同様の再利用可能な機能です。詳細については、再利用可能な共有フローの作成をご覧ください。

共有フローバンドルのディレクトリ構造

以下に示す共有フローバンドルのディレクトリ構造は、API プロキシ構成のディレクトリ構造に似ています。

共有フローバンドルのディレクトリ構造

共有フローバンドルの構成は、次のコンテンツで構成されます。

基本構成 プライマリ構成設定。
ポリシー Apigee ポリシー スキーマに準拠する XML 形式の構成ファイル。
リソース カスタムロジックを実行するためにポリシーが参照するスクリプト、JAR ファイル、XSLT ファイル。
共有フロー このバンドルに含まれる共有フロー。

基本構成

基本構成ファイルはバンドルのルート ディレクトリにあります。ファイルの名前はバンドルの名前です。

/sharedflowbundle/traffic-management-shared.xml

基本構成では、共有フローバンドルのコンテンツを定義し、加えてバンドルのリビジョン履歴を追跡するための情報を定義します。

<SharedFlowBundle revision="2" name="traffic-management-shared">
    <ConfigurationVersion majorVersion="4" minorVersion="0"/>
    <CreatedAt>1478637529218</CreatedAt>
    <CreatedBy>gladys@example.com</CreatedBy>
    <Description>Shared flow to moderate API traffic</Description>
    <DisplayName>traffic-management-shared</DisplayName>
    <LastModifiedAt>1481573374023</LastModifiedAt>
    <LastModifiedBy>gladys@example.com</LastModifiedBy>
    <Policies>
        <Policy>Auth-Flow-Callout</Policy>
        <Policy>Extract-Token</Policy>
        <Policy>Spike-Arrest</Policy>
    </Policies>
    <Resources>
        <Resource>jsc://extract-token.js</Resource>
    </Resources>
    <SharedFlows>
        <SharedFlow>default</SharedFlow>
    </SharedFlows>
</SharedFlowBundle>

基本構成の属性

名前 説明 デフォルト 必須
SharedFlowBundle
name 共有フローバンドルの名前で、組織内で一意にする必要があります。有効な文字は、A-Za-z0-9_- です。 該当なし
revision 共有フローバンドル構成のリビジョン番号。Apigee は共有フローの現在のリビジョンを自動的にトラッキングするため、リビジョン番号を明示的に設定する必要はありません。 該当なし ×

基本構成の要素

名前 説明 デフォルト 必須
SharedFlowBundle
ConfigurationVersion この共有フローが準拠する共有フローバンドル構成スキーマのバージョン。現在サポートされている値は majorVersion 4minorVersion 0 のみです。この設定は、共有フローバンドル フォーマットの進化を可能にするために将来使用される可能性があります。 4.0 ×
CreatedAtCreatedBy 共有フローバンドルが作成された日時(エポックタイム)と、その共有フローを作成したユーザーのメールアドレス。
Description 共有フローのテキスト形式の説明。指定すると、Apigee UI に説明が表示されます。 なし ×
DisplayName 共有フロー構成の name 属性とは異なる可能性のある、わかりやすい名前。 該当なし ×
LastModifiedAtLastModifiedBy 共有フローバンドルが最後に変更された日時(エポックタイム)と、その変更を行ったユーザーのメールアドレス。
Policies この共有フローの /policies ディレクトリにあるポリシーのリスト。通常、Edge 管理 UI を使用して共有フローを作成した場合にのみ、この要素が表示されます。これは単に「マニフェスト」設定であり、共有フローの内容を視認できるように設計されています。 なし ×
Resources この共有フローの /resources ディレクトリにあるリソース(JavaScript、Python、Java、XSLT)のリスト。通常、Apigee UI を使用して共有フローを作成した場合にのみ、この要素が表示されます。これは単にマニフェスト設定であり、共有フローの内容を視認できるように設計されています。 該当なし ×
SharedFlows このバンドルに含まれる共有フロー。 該当なし

ポリシー

/sharedflowbundle/policies

API プロキシと同様に、共有フローバンドルの /policies ディレクトリには、バンドル内の共有フローに接続できるすべてのポリシーの構成 XML が含まれています。ポリシーは要素のサブセットを共有しますが、このサブセットはポリシーに固有の要素で拡張されています。ポリシーの構成方法の詳細については、ポリシー リファレンスの概要をご覧ください。

リソース

/sharedflowbundle/resources

リソースは、ポリシーを使用して共有フローに添付できるスクリプト、コード、XSL 変換です。これらは、管理 UI の共有フローエディタの「スクリプト」セクションに表示されます。

サポートされるリソースタイプについては、リソースの管理をご覧ください。

共有フロー

/sharedflowbundle/sharedflows/default.xml

SharedFlow 構成は、フロー要素を実行する順序を定義します。<SharedFlow> 要素の <Step> 子要素はそれぞれ、ポリシーの呼び出しなど、順序の一部を指定します。

次の SharedFlow 構成では、3 つのポリシーが上から下への順序(管理コンソールでは左から右への順序)で実行されるように指定します。最初が Spike Arrest ポリシー、最後が Flow Callout ポリシーになります。

<SharedFlow name="default">
    <Step>
        <Name>Spike-Arrest</Name>
    </Step>
    <Step>
        <Name>Extract-Token</Name>
    </Step>
    <Step>
        <Name>Auth-Flow-Callout</Name>
    </Step>
</SharedFlow>

共有フロー構成の属性

名前 説明 デフォルト 必須
SharedFlow
name 共有フローの名前。組織内で一意にする必要があります。有効な文字は、A-Za-z0-9_- です。 該当なし
revision 共有フロー構成のリビジョン番号。Apigee は共有フローの現在のリビジョンを自動的にトラッキングするため、リビジョン番号を明示的に設定する必要はありません。 該当なし ×

共有フロー構成要素

名前 説明 デフォルト 必須
SharedFlow 共有フロー内のポリシーのシーケンス。 該当なし
Step フローのシーケンスのステージ。 該当なし
Name ステップで参照されるアイテムの名前。この要素の値は、ポリシーの name 属性の値など、項目の一意の識別子と同じである必要があります。 なし