在 API Gateway 中为 REST API 设置 API 密钥 - Amazon API Gateway
要求方法使用 API创建 API 密钥导入 API 密钥
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅 中国的 Amazon Web Services 服务入门 (PDF)。

在 API Gateway 中为 REST API 设置 API 密钥

要设置 API 键，请执行以下操作：

  • 将 API 方法配置为需要 API 键。

  • 为区域中的 API 创建或导入 API 密钥。

在设置 API 键之前，您必须先创建一个 API 并将其部署到某个阶段。创建 API 密钥值后，无法更改此值。

有关如何使用 API Gateway 控制台创建和部署 API 的说明，请分别参阅开发 API Gateway 中的 REST API和在 API Gateway 中部署 REST API。。

创建 API 密钥后，必须将其与使用计划相关联。有关更多信息，请参阅 在 API Gateway 中为 REST API 设置使用计划。

注意

有关可考虑的最佳实践，请参阅 API 密钥和使用计划的最佳实践。

要求方法使用 API

以下过程介绍如何将 API 方法配置为需要 API 密钥。

Amazon Web Services Management Console
将 API 方法配置为需要 API 密钥

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

  2. 选择一个 REST API。

  3. 在 API Gateway 主导航窗格中，选择资源。

  4. 在资源下，创建新方法或选择现有方法。

  5. 在方法请求选项卡上的方法请求设置下，选择编辑。

  6. 选择需要 API 密钥。

  7. 选择保存。

  8. 部署或重新部署 API 以使该要求生效。

如果需要 API 密钥选项设置为 false 并且您没有执行上述步骤，则与 API 阶段关联的任何 API 密钥都不会用于该方法。

Amazon CLI

以下 put-method 命令创建需要 API 密钥的 PUT 方法：

aws apigateway put-method \
    --rest-api-id 1234123412 \
    --resource-id a1b2c3 \
    --http-method PUT \
    --authorization-type "NONE" \
    --api-key-required

以下 update-method 命令将现有方法更新为需要 API 密钥：

aws apigateway update-method \
    --rest-api-id 1234123412 \
    --resource-id a1b2c3 \
    --http-method PUT \
    --patch-operations op="replace",path="/apiKeyRequired",value="true"
REST API

要让某个方法使用 API，请执行以下操作之一：

  • 调用 method:put 以创建方法。在请求负载中将 apiKeyRequired 设置为 true。

  • 调用 method:update 将 apiKeyRequired 设置为 true。

创建 API 密钥

以下过程说明如何创建 API 密钥。如果您想要导入 API 密钥，请跳过此步骤。

Amazon Web Services Management Console
创建 API 密钥

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

  2. 选择一个 REST API。

  3. 在 API Gateway 主导航窗格中，选择 API 密钥。

  4. 选择创建 API 密钥。

  5. 对于名称，输入名称。

  6. （可选）对于描述，输入描述。

  7. 对于 API 密钥，选择自动生成可让 API Gateway 生成密钥值，或者选择自定义以创建您自己的密钥值。

  8. 选择保存。

Amazon CLI

以下 create-api-key 命令创建 API 密钥：

 aws apigateway create-api-key \
    --name 'Dev API key' \
    --description 'API key for Devs' \
    --enabled
REST API

调用 apikey:create 以创建 API 密钥。

导入 API 密钥

以下过程介绍如何导入 API 密钥。如果您已创建 API 密钥，请跳过此步骤。

Amazon Web Services Management Console
导入 API 密钥

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

  2. 选择一个 REST API。

  3. 在主导航窗格中，选择 API 密钥。

  4. 选择操作下拉菜单，然后选择导入 API 密钥。

  5. 要加载逗号分隔的密钥文件，请选择选择文件。您也可以在文本编辑器中输入密钥。有关文件格式的信息，请参阅 API Gateway API 密钥文件格式。

  6. 选择收到警告停止以在出现错误时停止导入，或选择忽略警告以在出现警告时继续导入有效的密钥条目。

  7. 选择导入以导入您的 API 密钥。

Amazon CLI

以下 import-api-keys 命令导入 API 密钥：

aws apigateway import-api-key \
    a--body fileb://keys.csv \
    --format csv
REST API

调用 apikey:import 以从某个文件导入 API 密钥。有关文件格式的信息，请参阅 API Gateway API 密钥文件格式。

您无法更改新 API 密钥的值。创建 API 后，您将配置使用计划。有关更多信息，请参阅 在 API Gateway 中为 REST API 设置使用计划。