監査イベントの取得
Vonageアカウントに関連するすべての監査イベントの記録を取得できます。また、日付、キーワード、ユーザー、イベントタイプに基づいてこのリストをフィルタリングすることもできます。
このチュートリアルでは
監査イベントのフィルタリングされたリストを取得する方法を説明します:
前提条件
このチュートリアルに必要なものは以下の通り:
- A Vonageアカウント.
- ターミナル・アプリケーションを起動し、Curlコマンドを入力または貼り付けることができます。または、Paw、Postman または同様のアプリケーションを使用することもできます。
- を知る必要がある。
VONAGE_API_KEYそしてVONAGE_API_SECRETこれは、あなたの会社から入手できます。 ダッシュボード.
を参照することもできる。 Audit API ドキュメント.
注: 以下の例では VONAGE_API_KEY そして VONAGE_API_SECRET からの実際の値 ダッシュボード.
監査イベントのリストを取得する
すべての監査イベントのリストを受信するには、ターミナルに次のように入力します:
このコマンドを実行すると、すべての監査イベントのリストが表示されます。
監査イベントのフィルタリングされたリストを取得する
前のステップで受け取った監査イベントのリストは、特にVonageアカウントをしばらく使用している場合、圧倒されるかもしれません。このリストはいくつかのパラメータに基づいてフィルタリングすることができます:
| クエリ・パラメータ | 説明 |
|---|---|
event_type | 監査イベントのタイプ: APP_CREATE, NUMBER_ASSIGNなどがある。をカンマ区切りで指定できる。 イベントの種類 ここにある。 |
search_text | JSON互換の検索文字列。監査イベント内の特定のテキストを検索します。 |
date_from | この日付(ISO-8601 形式)から Audit イベントを取得します。 |
date_to | この日付までの Audit イベントを取得します(ISO-8601 形式)。 |
page | 1ページから始まるページ番号。 |
size | ページあたりの要素数(1〜100、デフォルトは30)。 |
例えば、日付に基づいてフィルターをかけるには、以下のコマンドを入力する:
$ curl "https://api.nexmo.com/beta/audit/events?date_from=2018-08-01&date_to=2018-08-31" \
-u 'VONAGE_API_KEY:VONAGE_API_SECRET'
これは、2018年8月中に発生したすべての監査イベントを返します。
さらにさまざまな方法で絞り込むことができる。例えば 監査イベントタイプ.
例えば、8月の監査イベントを見つけるには、次のようにします。 NUMBER_ASSIGN と入力すれば、次のようになる:
$ curl "https://api.nexmo.com/beta/audit/events?date_from=2018-08-01&date_to=2018-08-31&event_type=NUMBER_ASSIGN" \
-u 'VONAGE_API_KEY:VONAGE_API_SECRET'
さらに、以下の条件でフィルタリングすることができます。 search_text.例えば、"password "というテキストを含むすべての監査イベントを見つけるには、以下のコマンドを入力します:
$ curl "https://api.nexmo.com/beta/audit/events?search_text=password" \
-u 'VONAGE_API_KEY:VONAGE_API_SECRET'
特定の監査イベントを取得する
特定の監査イベントのUUIDを知っている場合、その監査イベント・オブジェクトの情報を取得することができます。例えば、イベントのUUIDが aaaaaaaa-bbbb-cccc-dddd-0123456789ab あなたが入ることになる:
$ curl "https://api.nexmo.com/beta/audit/events/aaaaaaaa-bbbb-cccc-dddd-0123456789ab" \
-u 'VONAGE_API_KEY:VONAGE_API_SECRET'
これにより、指定された監査イベントの監査イベント・オブジェクト JSON が返されます。
結論
Audit APIのフィルタリング機能を使用すると、取得する監査イベントを完全に制御できます。