API Gateway API キーファイルの形式

API Gateway はカンマ区切り値 (CSV) 形式の外部ファイルから API キーをインポートでき、インポートされたキーを 1 つ以上の使用量プランに関連付けます。インポートされたファイルには、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 キーを複数回インポートすることができ、最新バージョンは前のキーを上書きします。key 値が同じ場合、2 つの API キーは同一です。

注記

考慮すべきベストプラクティスについては、「API キーと使用量プランのベストプラクティス」を参照してください。