取消部署 API Proxy

本頁內容適用於 Apigee 和 Apigee Hybrid。

查看 Apigee Edge 說明文件。

如要從叢集取消部署 API Proxy 修訂版本，請參閱下列各節。

請注意，取消部署修訂版本時：

  • Apigee 不會將修訂版本復原為先前部署的修訂版本。
  • 取消部署後，環境中不會部署任何 API Proxy 修訂版本。

取消部署 API Proxy 與刪除 API Proxy 類似，但取消部署修訂版本後，您可以在 UI 中編輯該版本，然後重新部署。如果刪除 API Proxy，就無法再編輯。

全新 Proxy 編輯器

如要使用 UI 取消部署 API Proxy，請按照下列步驟操作：

  1. 如果您使用 Cloud 控制台中的 Apigee 使用者介面：選取「Proxy development」>「API Proxies」。

    如果您使用傳統的 Apigee 使用者介面：選取「Develop」>「API Proxies」，然後在「Proxies」窗格中，選取 Proxy 的環境。

  2. 選取要取消部署的 API Proxy。 使用者介面會顯示 API Proxy 的「總覽」檢視畫面。

    「總覽」檢視畫面中的 Proxy。

  3. 將游標懸停在「狀態」欄中的圖示上，然後選取「取消部署」：

    取消部署 Proxy。

傳統 Proxy 編輯器

如要使用 UI 取消部署 API Proxy，請按照下列步驟操作：

  1. 登入 Apigee 使用者介面。
  2. 選取「Develop」>「API Proxies」。

    使用者介面會顯示所選環境的現有 API Proxy 清單：

    系統會顯示 API Proxy 清單，包括名稱、狀態、24 小時內的流量、作者和上次修改時間。

  3. 選取要取消部署的 API Proxy。

    使用者介面會顯示 API Proxy 的「總覽」檢視畫面。

  4. 在所需環境列中，展開「修訂版本」下拉式清單，然後選取「取消部署」：

    生產環境的修訂版本下拉式選單，顯示「取消部署」項目

    使用者介面會提示您確認要取消部署的版本：

    提示確認取消部署動作的對話方塊

  5. 按一下「Undeploy」(取消部署)。

    UI 會立即更新狀態，顯示修訂版本已從叢集取消部署：

    下拉式選單顯示 API Proxy 已從測試環境取消部署

    不過請注意，解除部署程序可能需要一些時間 (在最終一致性模型中)。事實上，當您點選「Undeploy」(取消部署) 時，Apigee 會開始從叢集中的該環境取消部署所選修訂版本。

    如要瞭解如何查看未部署的 Proxy 狀態，請參閱「查看部署狀態」。

或者，您也可以在「Develop」(開發) 分頁中，取消部署目前正在編輯的修訂版本：

  1. 按一下「Deploy to: env_name」(部署至：env_name)env_name 下拉式清單：

    部署作業下拉式選單，可讓您將目前的修訂版本部署或取消部署至各個環境

    使用者介面會顯示環境清單。在「修訂版本」欄中，使用者介面會列出目前部署的修訂版本 (如果沒有，則為 &emdash;)，並顯示「部署」revision和「取消部署」按鈕。

  2. 按一下所需環境的「Undeploy」(取消部署) 按鈕。

    使用者介面會提示您確認要取消部署的版本：

    提示確認取消部署 API Proxy 作業的對話方塊

  3. 按一下「取消部署」按鈕。

    UI 會立即更新狀態，顯示修訂版本已取消部署。不過，解除部署程序可能需要一些時間 (在最終一致性模型中)。點選「Undeploy」(取消部署) 後，Apigee 會開始從該環境取消部署所選修訂版本。

Apigee API

如要取消部署 API Proxy，請使用下列 API 呼叫：

curl "https://apigee.googleapis.com/v1/organizations/$ORG/environments/$ENV/apis/$API/revisions/$REV/deployments" \
  -X DELETE \
  -H "Authorization: Bearer $TOKEN"

其中 $TOKEN 會設為您的 OAuth 2.0 存取權杖，如「取得 OAuth 2.0 存取權杖」一文所述。如要瞭解本範例使用的 curl 選項，請參閱「使用 curl」。如要瞭解可使用的環境變數，請參閱為 Apigee API 要求設定環境變數。

以下是回應輸出內容的範例 (空白回應)：

{}

詳情請參閱「取消部署 API Proxy 修訂版本 API」。

gcloud

下列各節提供使用 gcloud alpha apigee CLI 指令取消部署 API Proxy 修訂版本，以及驗證取消部署作業的範例。

如要進一步瞭解範例中使用的環境變數，請參閱「開始使用 gcloud 和 Apigee」。

使用 gcloud CLI 取消部署 API Proxy 修訂版本

如要取消部署 API Proxy 修訂版本，請使用下列 gcloud 指令： 

gcloud alpha apigee apis undeploy $REV --api=$API --environment=$ENV

以下是回應範例： 

Using Apigee organization `my-org`

使用 gcloud CLI 驗證 API Proxy 修訂版本是否已取消部署

如要驗證 API Proxy 修訂版本已從環境中取消部署，請使用下列 gcloud 指令： 

gcloud alpha apigee deployments list --api=$API --environment=$ENV

以下是回應範例： 

Using Apigee organization `my-org`
Listed 0 items.

詳情請參閱列出部署作業的 CLI。