使用環境

本頁適用於 ApigeeApigee Hybrid

查看 Apigee Edge 說明文件。

本節說明如何使用 Apigee 建立、編輯及刪除環境。

關於環境

環境是組織內的隔離區域,可用於建立部署 API Proxy。您可以在佈建期間建立環境,之後再將更多環境新增至貴機構。

環境和執行個體

每個環境都必須連結至至少一個 Apigee 執行個體。執行個體是特定區域的虛擬機器。將環境連結至執行個體,表示執行個體會為環境載入、部署及提供 Proxy。

環境連結的執行個體應與該環境流量最多的區域相符。如果新執行個體所在的區域有更多流量,您可以將環境新增至該執行個體,或將環境移至其他執行個體。

如要設定及變更環境的執行個體,請參閱「在執行個體中附加或移除環境」一文。

建立環境

您可以使用 Apigee UI 或 Apigee API 建立新環境,如以下各節所述。開始之前,請務必注意,Apigee 和 Apigee hybrid 針對每個機構和區域可建立的環境和環境群組數量設有限制。詳情請參閱「限制:環境和組織」。

在 UI 中建立新環境

Cloud 控制台中的 Apigee

如要在 Cloud 控制台中的 Apigee 中建立新環境,請按照下列步驟操作:

  1. 在瀏覽器中開啟 Cloud 控制台中的 Apigee UI
  2. 在左側導覽窗格中,依序選取「管理」>「環境」
  3. 在「環境」窗格中,按一下「+ 建立環境」
  4. 在「Create an environment」窗格中,輸入以下內容:
    • 選取環境類型:如果您是預付型客戶,請按一下「選取」,然後選擇要建立的環境類型:基本、中級或全面。

      環境類型選項不適用於訂閱方案客戶,也不會顯示在使用者介面中。

    • 名稱:程式輔助環境名稱。名稱建立後即無法變更。

      名稱必須包含 2 至 32 個字元,可使用小寫英文字母、數字或連字號。名稱開頭須為英文字母,結尾不得為連字號。名稱不得與貴機構的任何其他環境名稱相同。

    • 顯示名稱:在 UI 中顯示的環境名稱。
    • 說明:選填。環境說明。
    • Instance:選填。選取要為環境載入、部署及提供流量的 Apigee 執行個體。
    • 環境群組:選填。勾選核取方塊,將新環境新增至現有環境群組。按一下「確定」
    • 部署類型:選取要部署個別 API Proxy 還是 API Proxy 設定環境的封存檔。 詳情請參閱「支援的部署類型」。
  5. 按一下 [建立]。

完成後,新環境就會顯示在「Environments」窗格中的表格中。

傳統版 Apigee

如何在傳統版 Apigee UI 中建立新環境:

  1. 在瀏覽器中開啟 Apigee UI
  2. 在左側導覽窗格中,依序選取「管理」>「環境」>「總覽」

    UI 會顯示一組資訊卡,每張資訊卡代表一個現有環境:

    環境資訊卡

  3. 按一下「+ 環境」

    系統會顯示「New environment」對話方塊:

    「New Environment」對話方塊

  4. 在「New Environment」對話方塊中輸入以下資訊:
    1. 顯示名稱:在 UI 中使用的環境好記名稱。例如:My Test Environment
    2. 環境名稱:環境的程式輔助名稱。名稱只能使用小寫英文字母、數字和連字號。開頭須為小寫英文字母,結尾不得為連字號。例如:test

      環境名稱一經建立,即無法變更。

    3. 說明 (選填):您要新增為提醒的環境的其他資訊。
    4. 部署類型 (預先發布版):選取要部署個別 API Proxy 還是 API Proxy 設定環境的封存檔。 詳情請參閱「支援的部署類型」。

    除了「Description」欄位外,所有欄位均為必填。

  5. 按一下 [確定]

    在 Apigee 建立新環境時,資訊卡會顯示「Pending Provisioning」狀態,如以下範例所示:

    待佈建標籤

    新環境可能需要幾分鐘的時間才能佈建。

    完成後,Apigee UI 會將新環境以資訊卡的形式顯示,並與您建立的其他環境一併顯示:

    環境資訊卡

每個新環境都必須連結至 Apigee 執行個體環境群組

如果您在建立時未將環境附加至執行個體,可以透過執行個體 UI執行個體附件建立 API執行這項步驟。如要瞭解如何使用 API 執行這項操作,請參閱指令列佈建說明文件中的「建立環境」一節。

如果您在建立新環境時未指派給群組,請按照「將環境新增至環境群組」一文中的步驟操作。未指派給群組的環境沒有指向該環境的主機名稱,因此無法存取。詳情請參閱「建立環境群組」。

如果您有使用 Pay-as-you-go 帳單的 Apigee 機構,建議您在新環境中啟用 Apigee API Analytics 外掛程式。詳情請參閱「管理 Apigee API Analytics 外掛程式」。

使用 Apigee API 建立新環境

本節說明如何使用 Apigee API 建立新環境。

這項程序中的大部分步驟會觸發長時間執行的作業,可能需要幾分鐘才能完成。

如何使用 Apigee API 建立新環境:

  1. 使用 Create environments API 建立新環境。
  2. 使用執行個體附加 API,將環境附加至執行階段執行個體。
  3. 如果您還沒有環境群組,請建立一個。方法是使用 Create environment groups API
  4. 使用環境群組附加 API,將新環境附加至環境群組。

    將環境連結至群組後,該環境中的 Proxy 就能透過群組中的主機名稱進行路由。

如要進一步瞭解如何使用 Apigee API 建立及附加新環境,請參閱指令列佈建說明中的「建立環境」一節。

編輯環境

本節說明如何在 Apigee UI 中使用 Apigee API 編輯現有環境。

在 Apigee UI 中編輯環境

您可以在 Apigee UI 中變更現有環境的下列屬性:

  • 顯示名稱:輸入環境的新顯示名稱。
  • 說明:輸入環境的新說明。
  • 環境群組:取消勾選先前選取的核取方塊,然後選取新環境群組的核取方塊。

Cloud 控制台中的 Apigee

如要在 Cloud 控制台中的 Apigee 中編輯環境,請按照下列步驟操作:

  1. 在控制台中開啟 Apigee 頁面。

    前往 Apigee

  2. 選取要更新環境的專案。
  3. 在左側導覽窗格中,依序選取「管理」>「環境」
  4. 在要編輯的環境列中,按一下「動作」下方的三點圖示選單,然後選取「編輯」。系統會顯示「Edit environment」對話方塊。
  5. 選取環境類型:如果您是即付即用客戶,請選擇「選取環境類型」下方的選項,變更環境類型。選項包括「基本」、「中級」或「全面」

    環境類型選項不適用於訂閱方案客戶,也不會顯示在使用者介面中。

  6. 您可以在「顯示名稱」或「說明」欄位中進行任何必要的變更。
  7. 在「環境群組」清單方塊中,您可以取消勾選先前選取的核取方塊,並選取新環境群組的核取方塊。
  8. 按一下 [Update] (更新),儲存您所做的變更。

傳統版 Apigee

如何在傳統版 Apigee UI 中編輯環境

  1. 在瀏覽器中開啟 Apigee UI
  2. 選取「環境」
  3. 找出要編輯的環境資訊卡。

    以下範例顯示四種不同環境的資訊卡:

    環境資訊卡

  4. 按一下環境的窗格。

    Apigee UI 會在「關於」檢視畫面中顯示該環境的詳細資料:

    環境詳細資料

  5. 在「關於」檢視畫面中,按一下 「編輯」

    系統會顯示「Edit Environment」對話方塊:

    編輯環境詳細資料

  6. 編輯「顯示名稱」和「說明」欄位中的值。
  7. 按一下 [儲存]

使用 Apigee API 編輯環境

如要使用 Apigee API 編輯現有環境,請使用 Get environments API 取得可修改的目前資源清單,並使用 Update environments API 設定或變更這些資源。

在環境中設定轉送 Proxy

如要設定前置 Proxy,請使用environments API 為環境設定 forwardProxyUri 值。

停用環境中 Proxy 的轉送 Proxy

如果 API Proxy 的特定目標流量應直接傳送至後端目標,而略過轉送 Proxy,請在 TargetEndpoint 中設定下列屬性,以便覆寫 HTTP 轉送 Proxy:

<Property name="use.proxy">false</Property>

如要進一步瞭解如何設定 TargetEndpoint 屬性,包括如何設定與目標端點的連線,請參閱「端點屬性參考資料」。

針對您要透過 HTTP 轉送 Proxy 的任何 TargetEndpoint,將 use.proxy 設為「true」:

<Property name="use.proxy">true</Property>

刪除環境

刪除環境前,請務必考量下列重點:

  • 您必須先刪除所有鍵/值對應和鍵/值項目,才能刪除環境。 否則,如果您重新建立環境,則鍵值對應項目作業會遇到加密/解密差異。
  • 刪除已啟用 Apigee API Analytics 外掛程式 的環境時,系統也會一併刪除該環境的 Analytics 資料。如果您想保留任何環境的數據分析資料,建議您匯出資料並儲存在其他位置。如要進一步瞭解如何儲存資料,請參閱「 從 Analytics 匯出資料」一文。如要進一步瞭解環境刪除作業對 Apigee API Analytics 資料的影響,請參閱「管理 Apigee API Analytics 資料

使用 Apigee UI 刪除環境

Cloud 控制台中的 Apigee

如要在 Apigee in Cloud 控制台中刪除環境,請按照下列步驟操作:

  1. 在瀏覽器中開啟 Cloud 控制台中的 Apigee UI
  2. 在左側導覽窗格中,依序選取「管理」>「環境」
  3. 在要編輯的環境列中,按一下「動作」下方的三點圖示選單,然後選取「刪除」

傳統版 Apigee

  1. 在瀏覽器中開啟 Apigee UI
  2. 依序選取「管理」>「環境」>「總覽」

    Apigee 會顯示一組資訊卡,每張資訊卡代表 Apigee 機構中的一個環境。

  3. 找出要刪除的環境對應的卡片。
  4. 按一下環境的 選單,然後選取「Delete」

    Apigee 會顯示確認對話方塊。

  5. 按一下「確定」即可刪除環境。

    在 Apigee 刪除環境時,UI 中的環境資訊卡會顯示「Pending Deletion」標籤。

    刪除作業可能需要幾分鐘才能完成。

使用 Apigee API 刪除環境

如要刪除環境,請使用 Delete environments API