在 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 密钥。
- AWS Management Console
-
如果需要 API 密钥选项设置为 false 并且您没有执行上述步骤，则与 API 阶段关联的任何 API 密钥都不会用于该方法。
- AWS 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，请执行以下操作之一：
创建 API 密钥
以下过程说明如何创建 API 密钥。如果您想要导入 API 密钥，请跳过此步骤。
- AWS Management Console
- AWS 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 密钥，请跳过此步骤。
- AWS Management Console
- AWS 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 设置使用计划。
