禁用 REST API 的默认端点 - Amazon API Gateway

禁用 REST API 的默认端点

默认情况下，客户端可以通过使用 API Gateway 为 API 生成的 execute-api 端点来调用您的 API。为确保客户端只能通过使用自定义域名访问您的 API，请禁用默认 execute-api 终端节点。客户端仍然可以连接到您的默认端点，但它们会收到 403 Forbidden 状态码。禁用默认终端节点时，它会影响 API 的所有阶段。

以下过程说明了如何禁用 REST API 的默认端点。

AWS Management Console

  1. 通过以下网址登录到 Amazon API Gateway 控制台：https://console.aws.amazon.com/apigateway。

  2. 选择一个 REST API。

  3. 在主导航窗格中，选择 API 设置。

  4. 选择一个 API。

  5. 在 API 详细信息选项卡上，选择编辑。

  6. 对于默认端点，选择非活动。

  7. 选择 Save changes（保存更改）。

  8. 在主导航窗格中，选择资源。

  9. 选择部署 API。

  10. 重新部署您的 API 或创建一个新阶段，使更改生效。

AWS CLI

下面的 update-rest-api 命令显示了如何禁用默认端点：

aws apigateway update-rest-api \
    --rest-api-id abcdef123 \
    --patch-operations op=replace,path=/disableExecuteApiEndpoint,value='True'

禁用默认终端节点后，必须部署 API 才能使更改生效。

下面的 create-deployment 命令将创建一个部署。

aws apigateway create-deployment \
    --rest-api-id abcdef123 \
    --stage-name dev