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

禁用 REST API 的默认端点

默认情况下，客户端可以通过使用 API Gateway 为 API 生成的 execute-api 端点来调用您的 API。为确保客户端只能通过使用自定义域名访问您的 API，请禁用默认 execute-api 端点。禁用默认端点时，它会影响 API 的所有阶段。

以下过程演示了如何禁用 HTTP API 的默认端点。

AWS Management Console

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

  2. 选择 HTTP API。

  3. 选择 API 的 ID 以打开 API 详细信息页面。

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

  5. 对于默认端点，选择禁用。

  6. 选择保存。

    如果开启了阶段的自动部署，您无需重新部署 API 即可使更改生效。否则，您必须重新部署 API。

  7. （可选）选择部署，然后重新部署您的 API 或创建一个新阶段使更改生效。

AWS CLI

以下 update-domain-name 命令禁用 HTTP API 的默认端点：

aws apigatewayv2 update-api \
    --api-id abcdef123 \
    --disable-execute-api-endpoint

禁用默认端点后，除非启用了自动部署，否则必须部署 API 才能使更改生效。

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

aws apigatewayv2 create-deployment \
    --api-id abcdef123 \
    --stage-name dev