本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
API Gateway 可以從逗號分隔值 (CSV) 格式的外部檔案匯入 API 金鑰,然後建立已匯入金鑰與一或多個用量計劃的關聯性。匯入的檔案必須包含 Name
與 Key
欄位。欄標頭名稱不區分大小寫,各欄順序任意排列,如以下範例所示:
Key,name apikey1234abcdefghij0123456789,MyFirstApiKey
Key
值必須介於 20 到 128 個字元之間。Name
值不能超過 1024 個字元。
API 金鑰檔案也可以有 Description
、Enabled
或 UsagePlanIds
欄位,如下例所示:
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 金鑰和用量計劃的最佳實務。