第9章 API の定義 (メソッドおよびメトリクス)

API プロダクトレベルとバックエンドレベルの両方で、メソッドおよびメトリクスを追加して API を定義することができます。API プロダクトとは、1 つまたは複数の API バックエンドをバンドルしたものです。プロダクトレベルでは、メソッドおよびメトリクスにより、プロダクトのあらゆるアプリケーションプランの制限および課金ルールを設定することができます。バックエンドレベルでは、メソッドおよびメトリクスを使用して、バックエンドをバンドルするあらゆるプロダクトのアプリケーションプランの制限および課金ルールを設定することができます。

メトリクスは、プロダクトレベルとバックエンドレベルの両方で、API の使用状況を追跡するのに適しています。Hits は組み込みのメトリクスです。各 API に設定され、API に対するヒット数を追跡するのに使用されます。Hits メトリクス下で メソッド を定義することにより、API の使用状況をより細かな粒度で追跡することができます。メソッドにトラフィックがレポートされると、メソッドおよび Hits メトリクスのカウンターが自動的に加算されます。API バックエンドのエンドポイントごとに個別のメソッドを定義することや、エンドポイントと HTTP メソッドの組み合わせを定義することができます。API のエンドポイントをここで定義するメソッドにマッピングする方法については、マッピングルール の章を参照してください。

ヒット数以外で API の使用状況を測定するために、新たな メトリクス を定義して使用状況を別の単位で報告することができます。この単位は数値化が可能で、ビジネス目標に対して意味を持つものでなければなりません (例: メガバイト数、CPU 時間、API によって返される要素数など)。CPU 時間や mb 等の hits 以外のメトリクスは、すべてデフォルトの 3scale には含まれておらず、ユーザーが設定する外部サービスによって定期的に呼び出されるエンドポイントを使用して報告する必要があります。

メソッドとメトリクスは、API をパッケージングする際の基礎でもあります。それぞれのアプリケーションプランでは、メソッドおよびメトリクスごとに異なる使用制限および課金ルールを定義することができます。メトリクスおよびメソッドにレポートされる使用状況についての詳細は、API の解析 セクションを参照してください。

関連情報

API プロダクトおよび API バックエンドの詳細は、3scale スタートガイド を参照してください。

9.1. メソッドおよびメトリクスの追加

プロダクトまたはバックエンドに新たなメソッドを追加するには、以下の手順に従います。

  1. [Your_product_name] > Integration > Methods & Metrics または [Your_backend_name] > Methods & Metrics の順に移動します。
  2. メソッドリストの右上にある New method のリンクをクリックします。

  3. 以下のパラメーターを指定します。

    • Friendly name はメソッドの簡単な説明で、3scale 管理ポータルのさまざまなセクションに表示されます。この名前は、プロダクト単位で一意でなければなりません。
    • System name は、3scale Service Management API を通じて使用状況を報告するのに使用されるメソッドの名前です。この値も一意でなければならず、英数字、アンダースコア (_)、ハイフン (-)、およびスラッシュ (/) しか使用することはできません (スペースを使用することはできません)。それ以外は、自由に System name を指定することができます。エンドポイントとまったく同じにすることも (/status)、たとえばメソッドおよびパスを含めることもできます (GET_/status)。

    • Description フィールドはオプションで、メソッドをより詳細に説明する場合に使用することができます。

      New Method Details
  4. 最後に、Create Method をクリックします。

メソッドの定義は、後で変更することができます。メソッド名をクリックし (Method 列)、フィールドを更新して Update Method をクリックするだけです。

メソッドおよびメトリクスのシステム名を変更する場合やそれらを削除する場合は、十分に注意してください。メソッドの変更前のシステム名/削除したメソッドをポイントするマッピングルールがあると、これらの変更によりデプロイ済みの 3scale インテグレーションが機能しなくなります。

新たなメトリクスを作成するには、New metric をクリックして必要なパラメーターを指定します。単位を指定する際には、単数形の名詞 (例:hit) を使用します。Analytics のグラフでは、自動的に複数形になります。

これらの新たなメソッドおよびメトリクスは、現在および今後のすべてのプランで使用することができます。これ以降、各プランでメソッド/メトリクスに対する制限および課金ルールを編集することができます ([Your_product_name] > Applications > Application Plans > [plan_you_want_to_edit] の順に移動)。