如何获取与 Amazon API Gateway 的 API 密钥关联的使用情况?
解决方案
按照以下说明,使用 AWS 管理控制台或 AWS 命令行界面(AWS CLI)获取 API 密钥的使用情况。
**注意:**如果在运行 AWS CLI 命令时收到错误,请确保您使用的是最新版本的 AWS CLI。
使用 AWS 管理控制台
- 打开 API Gateway console(API Gateway 控制台)。
- 从导航窗格中,选择 APIs。
- 选择您的 API,然后选择 Usage Plans(使用计划)。
- 选择您的 Usage Plan(使用计划)。
- 选择 Actions(操作),然后选择 Export Usage Data(导出使用情况数据)。
- 选择导出 From(开始)和 To(结束)的日期范围。
- 对于 Export as(导出为),请选择 JSON 或 CSV,然后选择 Export(导出)。
有关更多信息,请参阅使用 API Gateway 控制台创建、配置和测试使用计划。
使用 AWS CLI
您可以使用 AWS CLI 命令 get-usage 在类似于以下的日期范围内获取使用计划的使用情况数据:
aws apigateway get-usage --usage-plan-id <usage-plan-id> --start-date "20xx-xx-xx" --end-date "20xx-xx-xx" --key-id <api-key-id>
**注意:**使用情况的日期范围不能超过 90 天。
有关更多信息,请参阅使用 API Gateway CLI 和 REST API 创建、配置和测试使用计划。
相关信息
API 密钥和使用计划的最佳实践