登录控制台
Amazon API Gateway
开发人员指南
AWS 文档 » Amazon API Gateway » 开发人员指南 » 发布您的 API Gateway API » 设置 API Gateway 金丝雀版本部署 » 禁用 Canary 版本
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅中国的 AWS 服务入门。

禁用 Canary 版本

要禁用 Canary 版本部署，请将 canarySettings 设置为空值以从阶段中删除它。

您可以使用 API Gateway 控制台、AWS CLI 或 AWS 开发工具包禁用 Canary 版本部署。

使用 API Gateway 控制台禁用 Canary 版本

要使用 API Gateway 控制台禁用金丝雀版本部署，请执行以下步骤：

  1. 登录到 API Gateway 控制台并在主导航窗格中选择现有 API。

  2. 在 API 下选择 Stages (阶段)，然后在 Stages (阶段) 列表下选择现有阶段以打开 Stage Editor (阶段编辑器)。

  3. 在 Stage Editor (阶段编辑器) 中选择 Canary (金丝雀版本) 选项卡。

  4. 选择 Delete Canary (删除金丝雀版本)。

  5. 选择删除确认您要删除金丝雀版本。

此时，canarySettings 属性变为 null，并从部署阶段中删除。您可以使用 AWS CLI 验证此项。有关示例，请查看使用 AWS CLI 禁用 Canary 版本。

使用 AWS CLI 禁用 Canary 版本

要使用 AWS CLI 禁用 Canary 版本部署，请按以下所示调用 update-stage 命令： 

aws apigateway update-stage \
    --rest-api-id 4wk1k4onj3 \
    --stage-name canary \
    --patch-operations '["op":"remove", "path":"/canarySettings"]'

成功的响应返回与以下类似的负载：

{
    "stageName": "prod", 
    "accessLogSettings": {
        ...
    }, 
    "cacheClusterEnabled": false, 
    "cacheClusterStatus": "NOT_AVAILABLE", 
    "deploymentId": "nfcn0x", 
    "lastUpdatedDate": 1511309280, 
    "createdDate": 1511152939, 
    "methodSettings": {
        ...
    }
}

如输出中所示，canarySettings 属性不再存在于已禁用金丝雀版本的部署的阶段中。