本頁適用於 Apigee 和 Apigee Hybrid。
查看
Apigee Edge 說明文件。
本節將說明如何使用 Apigee 建立及編輯環境群組,包括將環境或主機名稱新增至群組,或從群組中移除這些項目。如要進一步瞭解環境群組的定義和運作方式,請參閱環境和環境群組總覽。
建立環境群組
您可以使用 Apigee UI 或 Apigee API 建立新的環境群組。本節將說明如何執行這兩種操作。
初次建立環境群組時,群組內不會包含任何環境。不過,它會定義預設主機名稱:example.group-name。如要將環境新增至環境群組,請參閱「將環境新增至環境群組」。
Cloud 控制台中的 Apigee
如要在 Cloud 控制台中的 Apigee 中建立新的環境群組,請按照下列步驟操作:
- 在瀏覽器中開啟 Cloud 控制台中的 Apigee UI。
- 在左側導覽窗格中,依序選取「管理」>「環境」。
- 在「環境」窗格中,選取「環境群組」。
- 按一下「+ 建立環境群組」。
- 輸入下列內容:
- 環境群組名稱:環境群組的名稱。名稱開頭和結尾須為英數字元。最多可包含 63 個半形字元,且只能使用英數字元和連字號。名稱不得與貴機構中任何現有的環境群組名稱相同。
Hostames:可用於呼叫 Proxy 的主機名稱清單。每個主機名稱必須獨立成行。
您也可以點選「使用這些網域設定 Google 負載平衡器」。 這會在 Cloud 控制台中開啟「負載平衡」頁面,您可以在其中設定主機名稱的負載平衡。
- 環境:可選的環境清單,用於納入環境群組。
- 按一下 [建立]。
傳統版 Apigee
如要在傳統 Apigee UI 中建立新的環境群組,請按照下列步驟操作:
- 在 Apigee UI 中,依序選取「管理」>「環境」>「群組」。
- 按一下「+ 環境群組」:
系統會顯示「Add an Environment Group」對話方塊。
- 輸入新環境群組的名稱:
名稱只能使用小寫英文字母、數字和連字號。此外,開頭必須為英文字母,長度至少為兩個字元,結尾不得為連字號。有效的名稱包括
my-env-group
和prod2
。 - 按一下「新增」。
Apigee 會建立新的環境群組。這通常是快速的作業。
作業成功後,Apigee 會透過橫幅確認已建立群組,如下所示:
Apigee 也會為新群組指派預設主機名稱。
-
(選用) 按一下新群組的
,為該群組指派其他主機名稱。Apigee 會顯示「環境群組詳細資料」窗格:
- 將主機名稱新增至「Hostnames」欄位。每個主機名稱必須獨立成行。
-
完成後按一下 [儲存]。
您隨時可以使用相同的程序,在這個清單中新增及移除主機名稱。
Apigee API
如要使用 Apigee API 建立新的環境群組,請將 POST
要求傳送至 Create environment groups API。呼叫 API 前,請確認您有有效的權杖,如「取得 OAuth 2.0 存取權杖」一文所述。
以下 curl
指令範例說明建立新群組的語法:
curl -i $TOKEN -X POST \ https://apigee.googleapis.com/v1/organizations/ORG_NAME/envgroups?name=new-group-name
指定新群組名稱時,您只能使用小寫英文字母、數字和連字號 (a-z
、A-Z
和 -
)。您無法使用大寫英文字母或連字號以外的任何特殊字元。名稱開頭也必須為小寫英文字母。
如果您未指定任何其他參數,這個指令會建立新群組,但不會指派主機名稱。
您也可以在建立群組時指定主機名稱,方法是在要求的本文中將主機名稱指定為陣列。
以下範例會建立新的群組 my-group
,並將三個新的主機名稱指派給新群組:
curl -i $TOKEN -X POST \ https://apigee.googleapis.com/v1/organizations/org_name/envgroups?name=my-group \ -d '{ \ "hostnames": ["server1.mycompany.com", "server2.mycompany.com", "10.1.142.8"] \ }'
日後,您可以向 Patch environment groups API 傳送 PATCH
要求,藉此變更清單中的主機名稱。
將環境新增至環境群組
由於沒有與之相關聯的主機名稱,因此無法存取不在群組中的環境。主機名稱是在環境群組中定義,而不是在環境中定義。使用 Google Cloud 主控台的 Apigee UI 建立環境時,您可以選擇將環境指派至現有的環境群組。詳情請參閱「 在 UI 中建立新環境」。
如果您在建立環境時未將環境指派給群組,請參閱本節,瞭解如何使用 Apigee UI 或 Apigee API,將未指派的環境新增至環境群組。
Cloud 控制台中的 Apigee
如要在 Apigee in Cloud 控制台中將環境新增至環境群組,請按照下列步驟操作:
- 按照「建立環境」一文所述,建立環境。
- 在 Cloud 控制台的 Apigee UI 中,選取左側導覽窗格中的「Management」>「Environments」。
- 在「環境」窗格中,選取「環境群組」。
- 在環境群組的列中,按一下「動作」下方的三點圖示選單,然後選取「編輯」。
- 在「Edit Environment Group」窗格中的「Environments (Optional)」下方,選取要新增至環境群組的環境。
- 按一下「更新」。
傳統版 Apigee
如要在傳統版 Apigee UI 中將環境新增至環境群組,請按照下列步驟操作:
Apigee API
如要使用 Apigee API 將新環境新增至環境群組,請傳送 POST
要求至 環境群組附加元件 API,如以下範例所示:
curl -H "Authorization: Bearer $TOKEN" -X POST "https://apigee.googleapis.com/v1/organizations/my-org/envgroups/test-group/attachments" -d '{ "name": "my-attachment", "environment": "test" }'
其中:
$TOKEN
會設為您的 OAuth 2.0 存取憑證,如「取得 OAuth 2.0 存取憑證」一節所述。- 要求主體包含附件名稱和新環境的名稱。
要求主體包含 EnvironmentGroupAttachment 資源的例項,這是單一環境的簡單包裝函式。
如果成功,回應會包含新附件的詳細資料,包括建立時間戳記,例如:
{ "name": "my-attachment", "environment": "test" "createdAt": "42" }
從環境群組中移除環境
您可以使用 Apigee UI 或 Apigee API,從環境群組中移除環境。
Cloud 控制台中的 Apigee
如要在 Apigee in Cloud 控制台中從環境群組中移除環境,請按照下列步驟操作:
- 在 Cloud 控制台的 Apigee UI 中,選取左側導覽窗格中的「Management」>「Environments」。
- 在「環境」窗格中,選取「環境群組」。
- 在環境群組的資料列中,按一下「動作」下方的三點圖示選單,然後選取「編輯」。
- 在「編輯環境群組」窗格中的「環境 (選用)」下方,取消選取要從環境群組中移除的環境。
- 按一下「更新」。
傳統版 Apigee
如要在傳統 Apigee UI 中從環境群組中移除環境,請按照下列步驟操作:
- 在 Apigee UI 中,依序選取「管理」>「環境」>「總覽」。
- 選取要移除的環境。
- 在「群組」窗格中,將游標移至要移除環境的群組列結尾,然後按一下
。
Apigee API
如要使用 Apigee API 從環境群組中移除環境,請使用
EnvironmentGroupAttachment 資源中的 delete
方法,刪除與環境相對應的附件。
刪除環境群組
您可以使用 Apigee UI 或 API 刪除環境群組。
Cloud 控制台中的 Apigee
如要在 Apigee in Cloud 控制台中刪除環境群組,請按照下列步驟操作:
- 在 Cloud 控制台的 Apigee UI 中,選取左側導覽窗格中的「Management」>「Environments」。
- 在「環境」窗格中,選取「環境群組」。
- 在環境群組的資料列中,按一下「Actions」下方的三點圖示選單,然後選取「Delete」。
傳統版 Apigee
如要在傳統版 Apigee UI 中刪除環境群組,請按照下列步驟操作:
- 在 Apigee UI 中,依序選取「管理」>「環境」>「群組」。
- 將游標移至要刪除的群組窗格。
- 按一下
圖示。
Apigee API
如要使用 Apigee API 刪除環境群組,請在
EnvironmentGroup 資源中使用 delete
方法。
將主機名稱新增至群組
建立群組時,Apigee 會新增預設主機名稱 example.GROUP_NAME
。您可以按照本節中的操作說明,將主機名稱新增至群組。
您在環境群組中定義的主機名稱:
- 在機構的所有環境群組中必須是唯一值,且不得由多個群組使用
- 不支援萬用字元
- 主機中的基礎路徑不得重複 (主機中不得有兩個 Proxy 使用相同的基礎路徑)
Cloud 控制台中的 Apigee
如要在 Cloud 控制台中的 Apigee 中,將主機名稱新增至環境群組,請按照下列步驟操作:
- 在 Cloud 控制台的 Apigee UI 中,選取左側導覽窗格中的「Management」>「Environments」。
- 在「環境」窗格中,選取「環境群組」。
- 在環境群組的資料列中,按一下「動作」下方的三點圖示選單,然後選取「編輯」。
- 在「Edit Environment Group」窗格中的「Hostnames」下方,輸入要新增至環境群組的主機名稱。
- 按一下「更新」。
傳統版 Apigee
如要在傳統版 Apigee UI 中將主機名稱新增至環境群組,請按照下列步驟操作:
- 在 Apigee UI 中,依序選取「Admin」>「Environments」>「Groups」。
-
將游標懸停在群組資訊卡上,然後選取
。「環境群組詳細資料」窗格會顯示:
- 在「主機名稱」欄位中輸入新的主機。
- 按一下「儲存」,將新主機新增至群組。
Apigee API
如要使用 Apigee API 將主機名稱新增至環境群組,請將 PATCH
要求傳送至 Patch 環境群組 API。請務必將 updateMask
參數設為 hostnames
,並指定所需的主機名稱完整清單:請求中該欄位的值會取代現有清單。
以下範例會設定測試環境的主機名稱:
curl -H "Authorization: Bearer $TOKEN" -X PATCH "https://apigee.googleapis.com/v1/organizations/my-org/envgroups/test-group?updateMask=hostnames" -d '{ "name": "my-hostnames", "hostnames": [ "test-1.example.com", "test-2.example.com", "test-3.example.com" ] }'
其中:
$TOKEN
會設為您的 OAuth 2.0 存取憑證,如「取得 OAuth 2.0 存取憑證」一節所述。- 要求的酬載會指定主機名稱附件陣列的名稱,以及名稱本身的陣列。
如果要求成功,回應會包含 Operation 資源。
判斷 Cloud Load Balancer 是否已針對主機名稱進行設定
您可以使用下列指令呼叫 Proxy:
curl -v https://YOUR_ENV_GROUP_HOSTNAME/myproxy
其中 YOUR_ENV_GROUP_HOSTNAME
是環境群組的主機名稱,其中包含 Proxy 部署所在的環境。為此,您必須為環境群組主機名稱設定 Cloud Load Balancer。通常會在首次佈建 Apigee 時設定負載平衡器。如要判斷負載平衡器是否已針對主機名稱進行設定,請按照下列步驟操作:
- 在「管理」>「環境」>「群組」檢視畫面中,按一下主機名稱環境群組右側的編輯圖示。
- 按一下「使用這些網域設定 Google 負載平衡器」。系統會將您導向 Google Cloud Platform 負載平衡頁面。
按一下「名稱」欄中的負載平衡器名稱。如果 Apigee 是使用Provisioning 精靈進行佈建,負載平衡器的名稱會是
apigee-proxy-url-map
。如果您沒有看到該名稱,請與貴機構負責佈建 Apigee 的系統管理員聯絡。按一下名稱後,系統會顯示「Load balancer details」(負載平衡器詳細資料) 頁面:
- 在「Frontend」表格中,逐一點選「Certificate」欄中的 SSL 憑證,找出與主機名稱相符的 SSL 憑證:
- 如果憑證類型為「MANAGED」,請檢查憑證的 DNS 主機名稱欄位是否與主機名稱相符。
- 如果憑證未受管理,您可能需要下載憑證,並檢查其共用名稱是否與主機名稱相符。
如果您在任何憑證中都找不到主機名稱,請向系統管理員尋求進一步協助。