ログのAPI

概要

ログのAPIでは、ログや上位の統計などのクエリに単一の管理APIコマンドを使用できます。APIでは、SmartConsoleのログタブの検索バーと同じフィルタパラメータを使用します(以下の設定を参照)。

管理サーバでAPIを実行し、お使いの環境からのログを入手します。

ログのAPIで実行できること:

• 単一管理APIコマンドを使って環境のログサーバからログをフェッチする。

  入力:オプションクエリパラメーターには以下が含まれます。

  • ログタイプ:トラフィック/監査

  • 期間

  • フィルタ条件 - SmartConsoleのクエリラインに該当。

  • 特定ログサーバからのクエリ。

  • 結果を制限

  出力:JSONフォーマットですべてのフィールとログをマッチング。

• ページング - 小さなチャンクに分けてログをフェッチし(デフォルトと最大値は100)、クエリによってログサーバに負荷をかけすぎないようにします。結果の最初のページには、制限された数が表示されます。前回実行したクエリの続きの結果セットを入手するには、APIコマンドでquery-idを入力します。 

• 上位の統計 - 上位の発信元や宛先を含む複数のフィールドにおける上位の統計のクエリ。

• ログ添付のフェッチ:

  • クエリのレスポンスにある各ログには、添付があるかどうか示されます。添付は、パケットキャプチャまたはThreat Emulationレポートの場合があります。

  • 別のAPIコマンド(ログ添付API)では、ログIDごとに添付をフェッチして、1つのJSONレスポンスですべての添付を返します。

• 自動コマンド生成 - SmartConsoleでこのボタンをクリックすると、ログタブで現在表示されているクエリに基づいたAPIコマンドが生成されます。これには以下の項目が含まれます。

  • 期間。

  • 選択したログサーバ。

  • フィルタ条件 - クエリライン。

  • デフォルトの結果は50件。

ログのAPIのメカニズムはSmartConsoleログクエリと同じです。

権限はログインしたユーザプロファイルに基づいて実施されます。

設定

パラメータ	内容
フィルタ	SmartConsole/SmartViewで入力したフィルタ。 タイプ:文字列
期間	クエリログの期間を指定します。 有効な値： 過去7日間 過去1時間 今日 過去24時間 昨日 今週 今月 過去30日間 すべて カスタム デフォルト: 過去7日間 タイプ: 文字列
カスタムスタート	タイプ:文字列 ISO861フォーマット。
カスタムエンド	タイプ:文字列 ISO861フォーマット。
max-logs-per-request	有効な値：1-100 デフォルト値：10 タイプ:文字列
タイプ	返すログの種類 有効な値: ログ、監査 デフォルト: ログ タイプ:文字列
ログサーバ	クエリするログサーバのIPリスト デフォルト: すべて タイプ: 文字列

パラメータ	内容
回数	有効な値：1-50 タイプ:文字列
フィールド	有効な値： 発信元 宛先 サービス アクション ブレード オリジン ユーザ アプリケーション タイプ:文字列

既存クエリの結果をさらに取得するには

mgmt_cli show-logs query-id <query-id> --session-id <session-id>

パラメータ	内容
query-id	指定した制限で前回実行したクエリの次のページを取得します。 タイプ:文字列
ignore-warnings	警告を無視します(ある場合)。 タイプ: Boolean

制限

• APIコマンドのパラメータ"time-frame"で、

  "yyyymmddThhmmssZ"という入力フォーマットは使用できません。

• 非インデックスモードのログクエリはコマンドでサポートされません。