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

查看 Apigee Edge 說明文件。
前往 Apigee X說明文件。 資訊

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

基礎設定元素

名稱	說明	預設	必填與否
SharedFlowBundle
ConfigurationVersion	此共用流程的共用流程組合設定結構定義版本 沒有限制。目前唯一支援的值為 mainVersion 4 和 subVersion 0。這個 設定在未來可能會用於改進共用流程組合 格式。	4.0	否
CreatedAt和CreatedBy	共用流程組合的建立日期/時間 (以 Epoch 紀元時間為準)，以及 建立者的電子郵件地址。
Description	共用流程的文字說明。如有提供，說明會顯示在 Edge Management UI	不適用	否
DisplayName	易記的名稱，可能與網站的 name 屬性不同 共用流程設定	不適用	否
LastModifiedAt和LastModifiedBy	共用流程組合上次修改的日期/時間 (以 Epoch 紀元時間為準)，以及 修改後使用者的電子郵件。
Policies	此共用流程中 /policies 目錄中的政策清單。個人中心 通常只有在使用 Edge 建立共用流程時，才會看到這個元素 管理 UI這只是一項「資訊清單」方便您深入瞭解 共用流程的內容	不適用	否
Resources	/resources 中的資源清單 (JavaScript、Python、Java、XSLT) 這個共用流程的目錄您通常只會在共用流程時看到這個元素 是使用 Edge Management UI 建立而成這只是一項「資訊清單」設計目的為 可讓您在共用流程中看見共用流程的內容。	不適用	否
SharedFlows	指定這個套裝組合包含的共用流程。 請注意，這個元素目前只支援一個子項 <SharedFlow>。僅限 1 個 共用流程可能會新增至共用流程組合中。	不適用	是

共用流程

/sharedflowbundle/sharedflows/default.xml

SharedFlow 設定定義了流程元素應執行的順序。 <SharedFlow>元素的 <Step>每個子項元素都會指定序列中的一個部分 例如呼叫政策

下列 SharedFlow 設定會指定要在 由上而下序列 (在管理控制台中由左至右)，先列出《Spike Arrest 政策》， 流程呼叫政策 。

<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 Edge 會自動追蹤目前的 共用流程	不適用	否

共用流程設定元素

名稱	說明	預設	必填與否
SharedFlow	定義共用流程中的政策序列。	不適用	是
Step	定義步驟 -- 流程序列中的階段。	不適用	是
Name	指定步驟所參照的項目名稱。這個元素的值應該是 和項目的專屬 ID (例如政策的名稱屬性值)。	不適用	是

政策

/sharedflowbundle/policies

與 API Proxy 一樣，在共用流程組合中，/policies 目錄包含 設定 XML 設定，解釋所有可附加至套件中共用流程的政策。 政策共用一部分的元素， 政策特定問題如要進一步瞭解如何設定政策，請參閱政策相關主題 您期望的行為您也可以透過政策參考資料找到這些資訊 總覽頁面。

資源

/sharedflowbundle/resources

資源為指令碼、程式碼及 XSL 轉換，可附加至共用流程 建立政策這些異動會顯示在管理中共用流程編輯器的「指令碼」部分 第一種是使用無代碼解決方案 AutoML 透過使用者介面建立機器學習模型

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

前往 Apigee 開發人員論壇提問。