第9章 API の定義 (メソッドおよびメトリクス)
3scale で API を定義するには、Your_API_service > Integration > Methods & Metrics に移動し、メソッドとメトリクスを追加します。
Metrics を使用すると、3scale での API の使用状況を追跡できます。Hits は組み込みメトリックであり、各 API サービスに存在し、API に対するヒットを追跡するために使用されます。Hits メトリクス下で メソッド を定義することにより、API の使用状況をより細かな粒度で追跡することができます。メソッドにトラフィックを報告すると、メソッドと Hits メトリックのカウンターが自動的に増加します。API のエンドポイントごとに個別のメソッドを定義するか、エンドポイントと HTTP メソッドの組み合わせを定義できます。ここで定義されたメソッドに API のエンドポイントをマップする方法については、マッピングルール セクションを参照してください。
ヒット数以外で API の使用状況を測定するために、新たな メトリクス を定義して使用状況を別の単位で報告することができます。この単位は数値化が可能で、ビジネス目標に対して意味を持つものでなければなりません (例: メガバイト数、CPU 時間、または API によって返される要素数など)。CPU 時間や mb などの hits 以外のすべてのメトリクスは、デフォルトでは 3scale に含まれず、ユーザーが設定した外部サービスによって定期的に呼び出されるエンドポイントを使用してレポートする必要があります。
メソッドとメトリクスは、API をパッケージングする際の基礎でもあります。それぞれのアプリケーションプランでは、メソッドおよびメトリクスごとに異なる使用制限および課金ルールを定義することができます。
分析セクションのメトリクスとメソッドに報告された使用状況を確認できます。
9.1. メソッドとメトリックを手動で追加する
Your_API_name > Integration > Methods & Metrics に移動します。
- 新しいメソッドをクリックします。
以下のパラメーターを指定します。
- Friendly name はメソッドの簡単な説明で、3scale 管理ポータルのさまざまなセクションに表示されます。この名前は、サービスに対して一意である必要があります。
-
システム名は、3scale Service Management API を介して使用状況を報告するために使用されるメソッドの名前です。この値も一意でなければならず、英数字、アンダースコア (
_)、ハイフン (-)、およびスラッシュ (/) しか使用することはできません (スペースを使用することはできません)。それ以外は、システム名がどのように見えるかを自由に決定できます。エンドポイントとまったく同じにすることも (/status)、たとえばメソッドとパスを含めることもできます (GET_/status)。. Description フィールドはオプションで、メソッドをより詳細に説明する場合に使用することができます。
- 最後に、メソッドの作成 ボタンをクリックします。
メソッドの定義は、後で変更することができます。メソッド名をクリックし (Method 列)、フィールドを更新して Update Method をクリックするだけです。
メソッドとメトリクスのシステム名を変更したり、それらを削除したりする場合は十分に注意してください!メソッドの以前のシステム名を指すマッピングルールがある場合、すでにデプロイメントされている 3scale 統合が壊れる可能性があります。
新しいメトリックを作成するには、新しいメトリックをクリックし、必要なパラメーターを指定します。単位を指定するときは、Analytics グラフで自動的に複数形になるため、単数形の名詞 (hit など) を使用します。
これらの新たなメソッドおよびメトリクスは、現在および今後のすべてのプランで使用することができます。Your_API_service > Applications > Application Plans > plan_you_want_to_edit に移動して、各プランの制限と価格設定ルールを編集できるようになりました。
