取消部署 API Proxy

本頁適用於 Apigee 和 Apigee Hybrid。

查看 Apigee Edge 說明文件。

按照下列各節所述，從叢集中解除部署 API 代理程式修訂版本。

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

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

取消部署 API Proxy 的操作與刪除 API Proxy 類似，差別在於取消部署修訂版本時，您可以選擇在 UI 中編輯修訂版本，然後稍後重新部署。如果您刪除 API Proxy，就無法再編輯該 Proxy。

全新 Proxy 編輯器

如何使用使用者介面取消部署 API Proxy：

  1. 如果您使用的是 Cloud 控制台中的 Apigee UI：請依序選取「Proxy development」>「API Proxies」。

    如果您使用的是傳統 Apigee UI：請依序選取「Develop」>「API Proxies」，然後在「Proxies」窗格中選取 Proxy 的環境。

  2. 選取要解除部署的 API 代理程式。 使用者介面會顯示 API Proxy 的「總覽」檢視畫面。

    總覽檢視畫面中的 Proxy。

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

    取消部署 Proxy。

傳統 Proxy 編輯器

如何使用使用者介面取消部署 API Proxy：

  1. 登入 Apigee UI。
  2. 依序選取「Develop」>「API Proxies」。

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

    系統會顯示 API 代理程式清單，其中包含名稱、狀態、24 小時內的流量、作者和上次修改時間。

  3. 選取要解除部署的 API 代理程式。

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

  4. 在所需環境的資料列中，展開「Revision」下拉式清單，然後選取「Undeploy」：

    顯示「Undeploy」項目的產品環境修訂版本下拉式選單

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

    提示對話方塊，要求您確認取消部署操作

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

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

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

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

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

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

  1. 按一下「部署至：env_name」下拉式清單：

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

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

  2. 按一下所需環境的「Undeploy」按鈕。

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

    提示對話方塊，要求您確認 API Proxy 取消部署作業

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

    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 要求設定環境變數」。

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

{}

詳情請參閱 Undeploy API proxy revision API。

gcloud

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

如需進一步瞭解範例中使用的環境變數，以及相關說明，請參閱「開始使用 Apigee 搭配 gcloud」。

使用 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」一文。