API Gateway の API キーに関連する使用状況を確認する方法を教えてください。

解決策

以下の手順に従って、AWS マネジメントコンソールまたは AWS コマンドラインインターフェイス (AWS CLI) を使用して API キーの使用状況を取得します。

注: AWS CLI コマンドの実行中にエラーが発生した場合は、最新バージョンの AWS CLI を使用しているかどうかを確認してください。

AWS マネジメントコンソールを使用する

1. API Gateway コンソールを開きます。
2. ナビゲーションペインで **[API]**を選択します。
3. API を選択し、次に **[使用プラン]**を選択します。
4. **[使用プラン]**を選択します。
5. [アクション] を選択し、[使用状況データのエクスポート] を選択します。
6. エクスポートの開始日と終了日の範囲を選択します。
7. [名前を付けてエクスポート] で**[JSON]** または [CSV] を選択し、**[エクスポート]**を選択します。

詳細については、「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 キーと使用プランのベストプラクティス