使用 API Gateway 控制台创建、配置和测试使用计划
创建使用计划之前,请确保您已设置所需的 API 密钥。有关更多信息,请参阅 使用 API Gateway 控制台设置 API 密钥。
本节介绍如何使用 API Gateway 控制台创建和实施使用计划。
将您的 API 迁移到默认使用计划(如果需要)
如果您在 2016 年 8 月 11 日推出使用计划功能之后 开始使用 API Gateway,则会自动在所有受支持区域为您启用使用计划。
如果您在此日期之前开始使用 API Gateway,则可能需要迁移到默认使用计划。在选定区域中首次使用计划之前,系统将提示您选择 Enable Usage Plans (启用使用计划) 选项。在您启用此选项后,您将为与现有 API 密钥关联的每个唯一 API 阶段创建默认使用计划。在默认使用计划中,最初不设置限制或配额限制,API 密钥和 API 阶段之间的关联将复制到使用计划中。API 的行为方式将与之前相同。但是,您必须使用 UsagePlan
apiStages
属性(而不是使用 ApiKey stageKeys
属性)将指定的 API 阶段值(apiId
和 stage
)与所含的 API 密钥进行关联(通过 UsagePlanKey
)。
要检查您是否已迁移到默认使用计划,请使用 get-account
CLI 命令。在命令输出中,当启用使用计划时,features
列表将包括 "UsagePlans"
的条目。
您还可以使用 Amazon CLI 将您的 API 迁移到默认使用计划,如下所示:
使用 Amazon CLI 迁移到默认使用计划
-
调用此 CLI 命令:
update-account
-
对于
cli-input-json
参数,使用以下 JSON:[ { "op": "add", "path": "/features", "value": "UsagePlans" } ]
创建使用计划
以下过程介绍如何创建使用计划。
创建使用计划
-
在 Amazon API Gateway 主导航窗格中,选择使用计划,然后选择创建。
-
在 Create Usage Plan (创建使用计划) 下,执行以下操作:
-
对于 Name (名称),输入计划的名称(例如
Plan_A
)。 -
对于 Description (描述),输入事件的描述。
-
选择 Enable throttling (启用限制) 并设置 Rate (速率)(例如
100
)和 Burst (突增)(例如200
)。 -
选择 Enable quota(启用配额)并设置其在选定时间间隔(例如 Month (月))的值(例如
5000
)。 -
选择 Next (下一步)。
-
-
要向计划中添加阶段,请在 Associated API Stages (关联的 API 阶段) 窗格中执行以下操作:
-
选择 Add API Stage (添加 API 阶段)。
-
从 API 下拉列表中选择一个 API(例如
PetStore
)。 -
从 Stage (阶段) 下拉列表中选择一个阶段(例如
Stage_1
)。 -
选择对勾图标以保存。
-
-
要配置方法限制,请执行以下操作:
-
选择 Configure Method Throttling (配置方法限制)。
-
选择 Add Resource/Method (添加资源/方法)。
-
从 Resource (资源) 下拉菜单中选择资源。
-
从 Method (方法) 下拉菜单中选择方法。
-
设置 Rate (requests per second)(速率 (每秒请求数))(例如
100
)和 Burst (突增)(例如200
)。 -
选择对勾图标以保存。
-
选择 Close (关闭)。
-
-
要向计划中添加密钥,请在 API Keys (API 密钥) 选项卡中执行以下操作:
-
要使用现有密钥,请选择 Add API Key to Usage Plan (给使用计划添加 API 密钥)。
-
对于 Name (名称),为要添加的密钥输入名称(例如
MyFirstKey
)。 -
选择对勾图标以保存。
-
如果需要,请重复之前的步骤,向此使用计划添加其他现有 API 密钥。
注意 或者,要创建新 API 密钥并将它添加到使用计划,请选择 Create API Key and add to Usage Plan (创建 API 密钥并添加到使用计划),然后按照说明操作。
注意 一个 API 密钥可与多个使用计划关联。一个使用计划可与多个阶段关联。但是,对于 API 的每个阶段,给定 API 密钥只能与一个使用计划关联。
-
-
要完成创建使用计划,请选择 Done (完成)。
-
如果要向使用计划添加更多 API 阶段,则选择 Add API Stage (添加 API 阶段) 以重复前面的步骤。
测试使用计划
要测试使用计划,您可以使用 Amazon 软件开发工具包、Amazon CLI 或类似于 Postman 的 REST API 客户端。有关使用 Postman
维护使用计划
维护使用计划涉及监控给定时间段内的已用配额和剩余配额,并(如果需要)将剩余配额扩展指定的量。以下过程介绍如何监控和扩展配额。
监控已用配额和剩余配额
-
在 API Gateway 主导航窗格中,选择使用计划。
-
从使用计划列表中选择使用计划。
-
从指定计划中,选择 API Keys (API 密钥)。
-
选择 API 密钥,然后选择 Usage (使用) 以从您所监控的计划中查看 Subscriber's Traffic(订阅者的流量)。
-
(可选)依次选择 Export (导出)、From (从) 日期、To (到) 日期,为导出数据的格式选择
JSON
或CSV
,然后选择 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–3。
-
在使用计划窗格中,从使用计划窗口中选择 Extension (扩展)。
-
为 Remaining (剩余) 请求配额输入一个数字。
-
选择 Save。