API Gateway の API キーに関連付けられた使用状況を確認するにはどうすればよいですか?

解決方法

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

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

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

1. API Gateway コンソールにログインします。
2. ナビゲーションペインで、[APIs] (API) を選択します。
3. API を選択し、[Usage Plans] (使用プラン) を選択します。
4. [Usage Plans] (使用プラン) を選択します。
5. [Actions] (アクション)、[Export Usage Data] (使用量データをエクスポート) の順に選択します。
6. エクスポートの [From] (開始) と [To] (終了) の日付範囲を選択します。
7. [Export as] (エクスポート形式) で、[JSON] または [CSV] を選択し、[Export] (エクスポート) を選択します。

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