Amazon API Gateway
开发人员指南
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

使用 API Gateway 控制台设置 API 密钥

要设置 API 键,请执行以下操作:

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

  • 为区域的 API 创建或导入 API 键。

在设置 API 键之前,您必须先创建一个 API 并将其部署到某个阶段。

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

要求方法使用 API

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

将 API 方法配置为需要 API 密钥

  1. 登录 AWS 管理控制台 并通过 https://console.amazonaws.cn/apigateway/ 打开 API Gateway 控制台。

  2. 在 API Gateway 主导航窗格中,选择资源

  3. 资源下,创建新方法或选择现有方法。

  4. 选择 Method Request (方法请求)

  5. 授权设置部分下,为需要 API 键选择 true

  6. 选择对勾图标以保存设置。

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

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

创建 API 密钥

如果您已创建或导入 API 密钥以用于使用计划,则可跳过此过程和下一过程。

创建 API 密钥

  1. 登录 AWS 管理控制台 并通过 https://console.amazonaws.cn/apigateway/ 打开 API Gateway 控制台。

  2. 在 API Gateway 主导航窗格中,选择 API 密钥

  3. 操作下拉菜单中,选择创建 API 密钥

    
                            为使用计划创建 API 密钥
  4. 创建 API 密钥中,执行以下操作:

    1. 名称输入字段中,键入一个 API 密钥名称(例如 MyFirstKey)。

    2. 选择自动生成可让 API Gateway 生成密钥值,或选择自定义可手动输入密钥。

    3. 选择 Save (保存)

    
                            为使用计划创建 API 密钥
  5. 如果需要,重复上述步骤以创建多个 API 密钥。

导入 API 密钥

以下过程介绍如何导入 API 密钥以用于使用计划。

导入 API 密钥

  1. 在主导航窗格中,选择 API 密钥

  2. 操作下拉菜单中,选择导入 API 密钥

  3. 要加载逗号分隔的密钥文件,请选择选择 CSV 文件。您也可以手动键入密钥。有关文件格式的信息,请参阅 API Gateway API 密钥文件格式

    
                            API 使用计划实体
  4. 选择 Fail on warnings (收到警告停止) 以在出现错误时停止导入,或选择 Ignore warnings (忽略警告) 以在出现错误时继续导入有效的密钥条目。

  5. 要开始导入选定的 API 密钥,请选择 Import (导入)

您已设置 API 密钥,现在可以继续创建和实施使用计划