第19章 使用状況の詳細を把握するためのメソッドの指定およびメトリックの追加

アプリケーションプランでは、API へのコンシューマーアクセスに対して上限および課金ルールを設定します。上限および課金ルールの適用を有効にするには、個々の使用状況データを収集するメソッドを API に指定するか、メトリックを追加します。指定した各メソッドおよびカスタムメトリックにマッピングルールを追加します。マッピングルールは、把握する使用状況データの詳細を指定します。

プロダクトおよびバックエンドに対して、メソッドを指定したりメトリックを追加したりすることができます。プロダクトの場合、これにより、プロダクトのアプリケーションプランに上限および課金ルールを設定することができます。バックエンドの場合、これにより、そのバックエンドをバンドルするあらゆるプロダクトのアプリケーションプランに上限および課金ルールを設定することができます。

個々の呼び出しの数を把握するメソッドを指定します。これにより、API の使用をより細かい粒度で追跡することができます。メソッドにトラフィックがレポートされると、メソッドおよび Hits メトリックのカウンターが自動的に加算されます。API バックエンドのエンドポイントごとにメソッドを指定することや、エンドポイントと HTTP メソッドの組み合わせにメソッドを指定することができます。API のエンドポイントをここで追加するメソッドにマッピングする方法は、メソッドおよびメトリックへのマッピングルールの追加 を参照してください。

メトリックは、プロダクトとバックエンドの両方について、API の使用状況を追跡するのに適しています。Hits は、各 API に存在する組み込みのメトリックです。これは、API への呼び出しの数を追跡します。Hits とは別に API の使用状況を把握するには、使用状況を別の単位でレポートするメトリックを定義します。この単位は数値化が可能で、ビジネス目標に対して意味を持つものでなければなりません (例: メガバイト数、CPU 時間、または API によって返される要素数など)。CPU 時間や mb などの Hits 以外のメトリクスは、デフォルトでは提供されません。ユーザーが設定した外部サービスによって呼び出されるエンドポイントを使用して、これらのメトリクスを取得します。

メソッドおよびメトリックは、API をパッケージ化するための骨組みです。それぞれのアプリケーションプランにより、指定した各メソッドおよびメトリックに、異なる使用上限および課金ルールを定義することができます。メトリクスおよびメソッドにより報告される使用状況の詳細は、API の解析 を参照してください。