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

使用 API Gateway 控制台创建、配置和测试使用计划

创建使用计划之前,请确保您已设置所需的 API 密钥。有关更多信息,请参阅 使用 API Gateway 控制台设置 API 密钥

本节介绍如何使用 API Gateway 控制台创建和实施使用计划。

迁移到默认使用计划

如果您在 2016 年 8 月 11 日推出使用计划功能之后开始使用 API Gateway,则会自动在所有受支持区域为您启用使用计划。

如果您在此之前已开始使用 API Gateway,则在选定区域中首次使用 Usage Plans 之前,系统将提示您选择 Enable Usage Plans 选项。在您启用此选项后,您将为与现有 API 密钥关联的每个唯一 API 阶段创建默认使用计划。在默认使用计划中,最初未设置限制和配额限制,现有 API 密钥转换为 UsagePlanKey 资源集合,并且现有 API 密钥转换为 API 阶段 ID。API 的行为方式将与之前相同。但是,您必须使用 UsagePlan apiStages 属性 (而不是使用 ApiKey stageKeys 属性) 将指定的 API 阶段值 (apiIdstage) 与所含的 API 密钥进行关联 (通过 UsagePlanKey)。

创建使用计划

以下过程介绍如何创建使用计划。

创建使用计划

  1. 在 Amazon API Gateway 主导航窗格中,选择 Usage Plans,然后选择 Create

  2. Create Usage Plan 下,执行以下操作:

    1. 对于 Name,键入计划的名称 (例如 Plan_A)。

    2. 对于 Description,键入您的计划的描述。

    3. 选择 Enable throttling 并设置 Rate (例如 100) 和 Burst (例如 200)。

    4. 选择 Enable quota 并设置其在选定时间间隔 (例如 Month) 的限制 (例如 5000)。

    5. 选择 Save

     API 使用计划实体
  3. 要向计划中添加阶段,请在 Associated API Stages 窗格中执行以下操作:

    1. 选择 Add API Stage

    2. API 下拉列表中选择一个 API (例如 PetStore)。

    3. Stage 下拉列表中选择一个阶段 (例如 Stage_1)。

    4. 选择对勾图标以保存。

    5. 选择 Next

     API 使用计划实体
  4. 要向计划中添加密钥,请在 Usage Plan API Keys 窗格中执行以下操作:

    1. 要使用现有密钥,请选择 Add API Key to Usage Plan

    2. 对于 Name,为要添加的密钥键入名称 (例如 MyFirstKey)。

    3. 选择对勾图标以保存。

    4. 如果需要,请重复之前的步骤,向此使用计划添加其他现有 API 密钥。

     API 使用计划实体

    注意

    要向使用计划添加新 API 密钥,请选择 Create API Key and add to Usage Plan,然后按照说明操作。

  5. 要完成创建使用计划,请选择 Done

  6. 如果要向使用计划添加更多 API 阶段,则选择 Add API Stage 以重复前面的步骤。

测试使用计划

要测试使用计划,您可以使用 AWS 开发工具包、AWS CLI 或类似于 Postman 的 REST API 客户端。有关使用 Postman 测试使用计划的示例,请参阅测试使用计划

维护使用计划

维护使用计划涉及监控给定时间段内的已用配额和剩余配额,并将剩余配额扩展指定的量。以下过程介绍如何监控和扩展配额。

监控已用配额和剩余配额

  1. 在 API Gateway 主导航窗格中,选择 Usage Plans

  2. 从中间的二级导航窗格内的使用计划列表中选择一个使用计划。

  3. 从指定计划中,选择 API Keys

  4. 选择 API 密钥,然后选择 Usage 以从您所监控的计划中查看 Subscriber's Traffic

  5. (可选) 依次选择 ExportFrom 日期和 To 日期,选择 JSONCSV 作为导出数据的格式,然后选择 Export

    以下示例显示了一个导出的文件。

    { "thisPeriod": { "px1KW6...qBazOJH": [ [ 0, 5000 ], [ 0, 5000 ], [ 0, 10 ] ] }, "startDate": "2016-08-01", "endDate": "2016-08-03" }

    示例中的使用率数据显示了某 API 客户端在 2016 年 8 月 1 日至 2016 年 8 月 3 日期间的每日使用率数据,由 API 密钥 (px1KW6...qBazOJH) 标识。每个每日使用率数据均显示已用配额和剩余配额。在本例中,订阅者尚未使用任何分配的配额,并且 API 所有者或管理员已在第三天将剩余配额从 5000 减至 10。

扩展剩余配额

  1. 重复上述过程的步骤 1–3。

  2. 在使用计划页面上,从使用计划窗口中选择 Extension

  3. Remaining 请求配额键入一个数字。

  4. 选择 Save