API概要
API に基づくエンゲージメントルールの要約に関する参照表と使用例。
以下は、APIサマリーに基づくエンゲージメントルールに関する使用例です
- APIプロバイダーは、 エンゲージメントを使用して通知を受けることができます
- 特定のAPIに対するコールが四半期ごとに減少した場合。
- 前月と比較して、当月におけるリクエストの処理時間が増加している場合。
注： APIサマリーデータはより長期にわたって保持され、APIサマリーデータ用に作成されたルールを使用して、数ヶ月または数四半期にわたる長期トレンド分析を行うことができます。
以下の表は、API要約データソースで使用可能なフィールドのリストを示している。 これらのフィールドはルール定義リストでフィルターとして使用され、ルールのトリガーに使用されるデータに基づいてオプションを選択できる。
| フィールド | タイプ | 説明 |
|---|---|---|
| APIリファレンス | ストリング | APIリファレンス（api_name:api_version）。 |
| プロダクト・リファレンス | ストリング | 製品リファレンス（product_name:product_version）。 |
| app_name | ストリング | 登録されているアプリケーションの名前。 |
| catalog_name | ストリング | カタログの名前。 |
| space_name | ストリング | スペースが有効になっている場合、スペースの名前。 |
| ゲートウェイサービス名 | ストリング | DataPower API ゲートウェイサービス名。クラウド管理ユーザーがゲートウェイサービスを登録する際に設定する。 DataPower、 API Gateway、 v10.5.3 以上のバージョンでのみご利用いただけます。 |
| plan_id | ストリング | プラン ID。 |
| status_code | ストリング | アウトバウンド応答に設定された状況コード。 |
| bytes_received | 番号になります | リクエストで消費者から受信したバイト数。 |
| bytes_sent | 番号になります | レスポンスで消費者へ送信されたバイト数。 |
| time_to_serve_request | 番号になります | ゲートウェイがリクエストを受信してから応答を送信するまでの経過時間（ミリ秒単位）。 |