取消部署 API 代理

本页面适用于 Apigee 和 Apigee Hybrid。

查看 Apigee Edge 文档。

按照以下部分中的说明，从您的集群中取消部署 API 代理修订版。

请注意，当您取消部署修订版本时，会出现以下情况：

Apigee 不会将修订版本回滚到先前部署的修订版本。
取消部署后，环境中不会部署 API 代理的修订版。

取消部署 API 代理类似于删除 API代理，只不过在取消部署修订版本时，您可以选择在界面中修改修订版本并在将来重新部署。删除 API 代理后，便无法再修改此代理。

新版代理编辑器

如需使用界面取消部署 API 代理，请执行以下操作：

如果您使用的是 Cloud 控制台中的 Apigee 界面：选择代理开发 > API 代理。

如果您使用的是经典版 Apigee 界面：请选择开发 > API 代理，然后在代理窗格中，选择代理的环境。
选择要取消部署的 API 代理。界面会显示 API 代理的概览视图。
将光标悬停在状态列中的图标上，然后选择取消部署：

经典版代理编辑器

如需使用界面取消部署 API 代理，请执行以下操作：

登录 Apigee 界面。
依次选择开发 > API 代理。
界面会显示所选环境的当前 API 代理列表：
选择要取消部署的 API 代理。

界面会显示 API 代理的概览视图。
在所需的环境行中，展开修订版本下拉列表并选择取消部署：

界面会提示您确认要取消部署的版本：
点击取消部署。
界面会立即更新状态，以显示已从集群中取消部署修订版本：

但请注意，取消部署过程可能需要一些时间（在“最终一致性”模型中）。事实上，当您点击取消部署后，Apigee 即会从集群的该环境中开始取消部署选定的修订版本。

如需了解如何查看未部署代理的状态，请参阅查看部署状态。

或者，您也可以在开发标签页中取消部署您当前修改的修订版本：

点击部署到：env_name 下拉列表：

界面会显示环境列表。在修订版本列中，界面会列出当前部署的修订版本（如果未部署修订版本，则显示 &emdash;），并向您提示部署 revision 和取消部署按钮。
点击所需环境的取消部署按钮。
界面会提示您确认要取消部署的版本：
点击取消部署按钮。
界面会立即更新状态以显示已取消部署修订版本。但是，取消部署过程可能需要一些时间（在最终一致性模型中）。当您点击取消部署后，Apigee 即会开始从该环境中取消部署选定的修订版本。

Apigee API

如需取消部署 API 代理，请使用以下 API 调用：

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

按照获取 OAuth 2.0 访问令牌中的说明，将 $TOKEN 设置为您的 OAuth 2.0 访问令牌。如需了解此示例中使用的 curl 选项，请参阅使用 curl。如需了解您可以使用的环境变量，请参阅为 Apigee API 请求设置环境变量。

以下示例演示了响应输出（空响应）：

{}

如需了解详情，请参阅取消部署 API 代理修订版本 API。

gcloud

以下部分提供了使用 gcloud alpha apigee CLI 命令来取消部署 API 代理修订版本并验证取消部署的示例。

使用 gcloud CLI 取消部署 API 代理修订版本
使用 gcloud CLI 验证已取消部署 API 代理修订版本

如需详细了解示例中使用的环境变量，请参阅搭配使用 gcloud 与 Apigee 入门。

使用 gcloud CLI 取消部署 API 代理修订版本

如需取消部署 API 代理修订版本，请使用以下 gcloud 命令：

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

以下提供了一个响应示例：

Using Apigee organization `my-org`

使用 gcloud CLI 验证已取消部署 API 代理修订版本

如需验证 API 代理修订版本是否已从环境中取消部署，请使用以下 gcloud 命令：

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