API閘道API金鑰檔案格式

APIGateway 可以從逗號分隔值 (CSV) 格式的外部檔案匯入金API鑰，然後將匯入的金鑰與一或多個使用方案建立關聯。匯入的檔案必須包含 Name 與 Key 欄位。欄標頭名稱不區分大小寫，各欄順序任意排列，如以下範例所示：

Key,name
apikey1234abcdefghij0123456789,MyFirstApiKey

Key值必須介於 20 到 128 個字元之間。Name 值不能超過 1024 個字元。

API索引鍵檔案也可以有DescriptionEnabled、或UsagePlanIds欄，如下列範例所示：

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

當索引鍵與多個使用方案相關聯時，UsagePlanIds值是使用計劃的逗號分隔字串IDs，並以一對雙引號或單引號括住，如下列範例所示：

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

允許無法識別的欄位，但會被忽略。預設值為空白字串或 true 布林值。

可以多次匯入相同的API金鑰，最新版本會覆寫前一個金鑰。如果兩個API鍵具有相同的key值，則它們是相同的。