API Gateway API 密钥文件格式 - Amazon API Gateway
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅 中国的 Amazon Web Services 服务入门 (PDF)

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

API Gateway API 密钥文件格式

API Gateway 可以从逗号分隔值 (CSV) 格式的外部文件导入 API 密钥,然后将导入的密钥与一个或多个使用计划关联。导入的文件必须包含 NameKey 列。列标头名称不区分大小写,并且这些列可以采用任何顺序,如以下示例所示:

Key,name apikey1234abcdefghij0123456789,MyFirstApiKey

Key值必须介于 20 到 128 个字符之间。Name 值不能超过 1024 个字符。

API 密钥文件也可以包含 DescriptionEnabledUsagePlanIds 列,如以下示例所示:

Name,key,description,Enabled,usageplanIds MyFirstApiKey,apikey1234abcdefghij0123456789,An imported key,TRUE,c7y23b

当密钥与多个使用计划关联时,UsagePlanIds 值是用双引号或单引号引起来的使用计划 ID 的逗号分隔字符串,如以下示例所示:

Enabled,Name,key,UsageplanIds true,MyFirstApiKey,apikey1234abcdefghij0123456789,"c7y23b,glvrsr"

允许使用无法识别的列,但会忽略这些列。默认值为空字符串或 true 布尔值。

同一个 API 密钥可以多次导入,最新版本将覆盖前一个版本。如果两个 API 密钥具有相同的 key 值,则这两个密钥相同。

注意

有关可考虑的最佳实践,请参阅 API 密钥和使用计划的最佳实践