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

您目前查看的是 Apigee Edge 說明文件。
前往 Apigee X 說明文件。 info

共用流程是可重複使用的功能，類似於 API Proxy。如果您已熟悉 API Proxy，應該會覺得這份參考資料的許多內容似曾相識。

如果您正在學習如何建構共用流程，請先閱讀「可重複使用的共用流程」主題。

共用流程組合結構

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

基本設定 主要設定。請參閱「基本設定」。
政策 符合 Apigee Edge 政策結構定義的 XML 格式設定檔。請參閱政策。
資源 政策參照的指令碼、JAR 檔案和 XSLT 檔案，用於執行自訂邏輯。請參閱「資源」。
SharedFlows 這個套件包含共用流程。請參閱共用流程。

上表中的元件是由下列目錄結構中的設定檔定義：

共用流程組合的設定檔和目錄結構

本節說明共用流程組合的設定檔和目錄結構。

基礎設定

基本設定檔位於套件的根目錄。名稱是套件的名稱。

/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_- N/A 是
revision 共用流程組合設定的修訂版本號碼。您不需要明確設定修訂版本號碼，因為 Apigee Edge 會自動追蹤共用流程的目前修訂版本。 N/A 否

基礎設定元素

名稱 說明 預設 是否必要？
SharedFlowBundle
ConfigurationVersion 這個共用流程遵循的共用流程組合設定結構定義版本。目前唯一支援的值是 majorVersion 4 和 minorVersion 0。這項設定日後可能會用於啟用共用流程套件格式的演進功能。 4.0 否
CreatedAt和CreatedBy 共用流程套裝組合的建立日期/時間 (以 Epoch 時間表示)，以及建立者的電子郵件地址。
Description 共用流程的文字說明。如果提供說明，Edge 管理 UI 就會顯示。 N/A 否
DisplayName 方便辨識的名稱，可能與共用流程設定的 name 屬性不同。 N/A 否
LastModifiedAt和LastModifiedBy 上次修改共用流程套裝組合的日期/時間 (以紀元時間表示)，以及修改者的電子郵件地址。
Policies 這個共用流程的 /policies 目錄中的政策清單。一般來說，只有在使用 Edge 管理 UI 建立共用流程時，才會看到這個元素。這只是「資訊清單」設定，旨在提供共用流程內容的能見度。 N/A 否
Resources 這個共用流程的 /resources 目錄中的資源清單 (JavaScript、Python、Java、XSLT)。一般來說，只有在使用 Edge 管理 UI 建立共用流程時，才會看到這個元素。這只是「資訊清單」設定，旨在提供共用流程內容的能見度。 N/A 否
SharedFlows 指定這個組合包含的共用流程。

請注意，這個元素目前只支援一個子項 <SharedFlow>。共用流程組合只能新增一個共用流程。

 N/A 是

共用流程

/sharedflowbundle/sharedflows/default.xml

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

下列 SharedFlow 設定指定要依從上到下 (管理控制台中從左到右) 的順序執行三項政策，其中尖峰流量防護政策會先執行，流程 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_- N/A 是
revision 共用流程設定的修訂版本號碼。您不需要明確設定修訂版本號碼，因為 Apigee Edge 會自動追蹤共用流程的目前修訂版本。 N/A 否

共用流程設定元素

名稱 說明 預設 是否必要？
SharedFlow 定義共用流程中的政策順序。 N/A 是
Step 定義步驟，也就是流程序列中的階段。 N/A 是
Name 指定步驟參照的項目名稱。這個元素的值應與項目的專屬 ID 相同，例如政策的名稱屬性值。 N/A 是

政策

/sharedflowbundle/policies

與 API Proxy 相同，共用流程組合中的 /policies 目錄包含所有可附加至組合中共用流程的政策設定 XML。政策會共用部分元素，但這個子集會擴增政策專屬的元素。如要進一步瞭解如何設定政策，請參閱相關政策主題。您也可以從政策參考總覽存取這些內容。

資源

/sharedflowbundle/resources

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

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

將問題發布到 Apigee 開發人員論壇。