创建使用计划之前,请确保您已设置所需的 API 密钥。有关更多信息,请参阅 使用 API Gateway 控制台设置 API 密钥。
本节介绍如何使用 API Gateway 控制台创建和实施使用计划。
将您的 API 迁移到默认使用计划(如果需要)
如果您在 2016 年 8 月 11 日推出使用计划特征之后 开始使用 API Gateway,则会自动在所有受支持区域为您启用使用计划。
如果您在此日期之前开始使用 API Gateway,则可能需要迁移到默认使用计划。在选定区域中首次使用计划之前,系统将提示您选择启用使用计划选项。在您启用此选项后,您将为与现有 API 密钥关联的每个唯一 API 阶段创建默认使用计划。在默认使用计划中,最初不设置限制或配额限制,API 密钥和 API 阶段之间的关联将复制到使用计划中。API 的行为方式将与之前相同。但是,您必须使用 UsagePlan
apiStages
属性(而不是使用 ApiKey stageKeys
属性)将指定的 API 阶段值(apiId
和 stage
)与所含的 API 密钥进行关联(通过 UsagePlanKey
)。
要检查您是否已迁移到默认使用计划,请使用 get-account
CLI 命令。在命令输出中,当启用使用计划时,features
列表将包括 "UsagePlans"
的条目。
您还可以使用 AWS CLI 将您的 API 迁移到默认使用计划,如下所示:
使用 AWS CLI 迁移到默认使用计划
-
调用此 CLI 命令:
update-account
-
对于
cli-input-json
参数,使用以下 JSON:[ { "op": "add", "path": "/features", "value": "UsagePlans" } ]
创建使用计划
以下过程介绍如何创建使用计划。
创建使用计划
通过以下网址登录到 Amazon API Gateway 控制台:https://console.aws.amazon.com/apigateway
。 -
在 API Gateway 主导航窗格中,选择使用计划,然后选择创建使用计划。
-
对于名称,输入名称。
-
(可选)对于描述,输入描述。
-
默认情况下,使用计划会启用节流。为您的使用计划输入速率和突增。选择节流可关闭节流。
-
默认情况下,使用计划会针对一个时间段启用配额。对于请求,输入用户在使用计划的时间段内,可以发出的请求总数。选择配额可关闭配额。
-
选择创建使用计划。
向使用计划添加阶段
-
选择您的使用计划。
-
在关联的阶段选项卡下,选择添加阶段。
-
对于 API,选择一个 API。
-
对于阶段,选择一个阶段。
-
(可选)要开启方法级别的节流,请执行以下操作:
-
选择方法级别节流,然后选择添加方法。
-
对于资源,从您的 API 中选择一个资源。
-
对于方法,从您的 API 中选择一种方法。
-
为您的使用计划输入速率和突增。
-
-
选择添加至使用计划。
向使用计划添加密钥
-
在关联的 API 密钥选项卡下,选择添加 API 密钥。
-
-
要将现有密钥与您的使用计划关联,请选择添加现有密钥,然后从下拉菜单中选择您的现有密钥。
-
要创建新 API 密钥,请选择创建并添加新密钥,然后创建新密钥。有关如何创建新密钥的更多信息,请参阅创建 API 密钥。
-
-
选择添加 API 密钥。
测试使用计划
要测试使用计划,您可以使用 AWS 软件开发工具包、AWS CLI 或类似于 Postman 的 REST API 客户端。有关使用 Postman
维护使用计划
维护使用计划涉及监控给定时间段内的已用配额和剩余配额,并(如果需要)将剩余配额扩展指定的量。以下过程介绍如何监控配额。
监控已用配额和剩余配额
通过以下网址登录到 Amazon API Gateway 控制台:https://console.aws.amazon.com/apigateway
。 -
在 API Gateway 主导航窗格中,选择使用计划。
-
选择一个使用计划。
-
选择关联的 API 密钥选项卡,查看每个密钥在时间段内剩余的请求数。
-
(可选)选择导出使用数据,然后选择开始日期和结束日期。接下来,为导出的数据选择 JSON 或 CSV 格式,然后选择导出。
以下示例显示了一个导出的文件。
{ "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。
以下过程介绍如何修改配额。
扩展剩余配额
通过以下网址登录到 Amazon API Gateway 控制台:https://console.aws.amazon.com/apigateway
。 -
在 API Gateway 主导航窗格中,选择使用计划。
-
选择一个使用计划。
-
选择关联的 API 密钥选项卡,查看每个密钥在时间段内剩余的请求数。
-
选择 API 密钥,然后选择授予使用延期。
-
为剩余请求配额输入一个数字。对于使用计划中的时间段,您可以增加剩余的请求数或减少剩余的请求数。
选择更新配额。