トランザクション・データ

オンライン編集

webMethods API Gateway はAPIトランザクションを照会する機能を提供する。 APIトランザクションは、API呼び出しが発生するたびに（イベントとして）生成される。 APIトランザクションには、リクエストとレスポンスのヘッダー、リクエストとレスポンスのペイロード、コンシューマーアプリケーションなど、呼び出しに関する詳細が含まれる。 APIプロバイダーは、ログ呼び出しポリシーを使用して、これらのイベントを1つまたは複数の宛先に保存することを選択できる。 webMethods API Gateway は、API プロバイダーに対して、イベントを保存できるさまざまな保存先オプションを提供する( API Gateway '自身のデータストア、リレーショナルデータベース、 Elasticsearch )。 デフォルトでは webMethods API Gateway がこれらのイベントの保存先として選択される。 このREST APIは、トランザクションデータを webMethods API Gateway からのトランザクションデータのみを照会します。 この取引データは複数のユースケースで使用できる。 例えば、このAPIを課金システムと統合することができ、このトランザクションデータは、マネタイズのユースケースのために、異なる消費者のAPIの使用履歴を計算するために使用することができる。 他のシナリオでは、このサービスから抽出されたデータは、カスタムレポート生成に使用することができます。

webMethods API Gateway は、以下の REST API と、トランザクションイベントデータを取得するためのリソースを提供する：

  • GET/rest/apigateway/transactionEvents/_search

    特定期間のAPI、アプリケーション、プラン、パッケージのトランザクションイベントを取得します。 このメソッドの複数のリクエストパラメータは、期待される結果にマッチするリクエスト基準を指定するオプションを提供し、これらの入力パラメータのほとんどは、その値で正規表現をサポートしています。 必須パラメータ、 fromDate、 toDate, とともに、他のフィルター基準のいずれかがリクエストに渡される。

  • GET/rest/apigateway/transactionEvents/_count

    特定の期間におけるAPI、アプリケーション、プラン、パッケージのトランザクションイベント数を取得します。 このメソッドの複数のリクエストパラメータは、期待される結果にマッチするリクエスト基準を指定するオプションを提供し、これらの入力パラメータのほとんどは、その値で正規表現をサポートしています。 必須パラメータ、 fromDate、 toDate, とともに、他のフィルター基準のいずれかがリクエストに渡される。