共用流程組合設定參考資料

本頁適用於 Apigee 和 Apigee Hybrid。

查看 Apigee Edge 說明文件。

共用流程是可重複使用的功能，類似於 API Proxy。詳情請參閱「建立可重複使用的共用流程」。

共用流程組合目錄結構

共用流程套件目錄結構 (如下所示) 與 API Proxy 設定目錄結構相似。

共用流程組合目錄結構

共用流程組合設定包含下列內容：

基本設定 主要設定。
政策 符合 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 4 和 minorVersion 0。這項設定日後可能會用於協助共用流程組合格式演進。 4.0 否
CreatedAt 和 CreatedBy 建立共用流程套件的日期/時間 (以紀元時間表示)，以及建立者使用的電子郵件地址。
Description 共用流程的文字說明。如果提供，說明會顯示在 Apigee UI 中。 不適用 否
DisplayName 使用者友善名稱，可能與共用流程設定的 name 屬性不同。 不適用 否
LastModifiedAt 和 LastModifiedBy 共用流程套件的上次修改日期/時間 (以紀元時間表示)，以及修改該套件的使用者電子郵件。
Policies 這個共用流程的 /policies 目錄中政策清單。一般來說，只有在使用 Edge 管理 UI 建立共用流程時，您才會看到這個元素。這只是一個「資訊清單」設定，旨在讓您瞭解共用流程的內容。 不適用 否
Resources 這個共用流程的 /resources 目錄中資源 (JavaScript、Python、Java、XSLT) 清單。您通常只會在使用 Apigee UI 建立共用流程時看到這個元素。這只是資訊清單設定，旨在提供共用流程內容的瀏覽權限。 不適用 否
SharedFlows 這個組合所含的共用流程。 不適用 是

政策

/sharedflowbundle/policies

與 API Proxy 一樣，在共用流程組合中，/policies 目錄會包含所有可附加至組合中共用流程的政策設定 XML。政策會共用一組元素，但這組元素會加入特定政策的元素。如要進一步瞭解如何設定政策，請參閱政策參考資料總覽。

資源

/sharedflowbundle/resources

資源是指可使用政策附加至共用流程的指令碼、程式碼和 XSL 轉換。這些資訊會顯示在管理介面中共用流程編輯器的「腳本」部分。

如要瞭解支援的資源類型，請參閱「管理資源」。

共用流程

/sharedflowbundle/sharedflows/default.xml

SharedFlow 設定會定義流程元素應執行的順序。<SharedFlow> 元素的 <Step> 子元素會分別指定序列的一部分，例如政策的呼叫。

下列 SharedFlow 設定會指定三個政策，以由上而下的順序 (在管理控制台中由左至右) 執行，其中 SpikeArrest 政策會先執行，最後再執行 FlowCallout 政策。

<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 步驟參照的項目名稱。這個元素的值應與項目的專屬 ID 相同，例如政策的名稱屬性值。 不適用 是