Amazon API Gateway
開発者ガイド

API Gateway で API ダッシュボードにより CloudWatch メトリクスを表示する

API Gateway コンソールの API ダッシュボードを使用して、API Gateway でデプロイした API の CloudWatch メトリクスを表示できます。これは、時間の経過に伴う API アクティビティの概要として表示されます。

前提条件

  1. API Gateway で API が作成済みであることが必要です。「Amazon API Gateway で REST API を作成する」の手順に従います。

  2. API は少なくとも一度はデプロイする必要があります。「Amazon API Gateway での REST API のデプロイ」の手順に従います。

  3. 個別のメソッドの CloudWatch メトリクスを取得するには、「ステージ設定の更新」で説明されているとおり、特定のステージのこれらのメソッドに対して CloudWatch ログを有効にする必要があります。アカウントではメソッドレベルのログに対して課金されますが、API またはステージレベルのログへのアクセスに対しては課金されません。

ダッシュボードでの API アクティビティの調査

  1. https://console.aws.amazon.com/apigateway で API Gateway コンソールにサインインします。

  2. API の名前を選択します。

  3. 選択した API で、[ダッシュボード] を選択します。

  4. API アクティビティの概要を時間の経過とともに表示するには、[ステージ] で目的のステージを選択します。

  5. [開始日] と [終了日] を使用して日付範囲を入力します。

  6. [API コール]、[統合のレイテンシー]、[レイテンシー]、[4xx エラー]、および [5xx エラー] というタイトルの個別のグラフに表示される各メトリクスを、必要に応じて更新して確認します。CacheHitCountCacheMissCount グラフは、API キャッシュが有効になっている場合にのみ表示されます。

    ヒント

    メソッドレベルの CloudWatch メトリクスを調べるには、メソッドレベルで CloudWatch ログを有効にしていることを確認します。メソッドレベルのログの設定方法については、「API Gateway コンソールによるステージ設定の更新」を参照してください。