7.2.1　イベント

(1)　イベント情報オブジェクト

機能

イベント情報を表すオブジェクトです。

形式

{
    "sid":"JP1イベントのSID",
    "value": [
        "イベント属性名":"イベント属性値",…
    ],
    "title": [
        "イベント属性名":"イベント属性の表示項目名",…
    ],
    "type": [
        "イベント属性名":"イベント属性のタイプ",…
    ],
    "monitor": [
         イベントを発行した連携製品のモニター画面呼び出し情報
    ]
}

メンバー

メンバーを次の表に示します。

表7‒13　イベント情報オブジェクトのメンバー

項番	メンバー	データ型	説明
1	sid	string	イベントを一意に識別するJP1イベントのSIDを指定します。形式を次に示します。 _JP1IM_マネージャーホスト名/_JP1IMSEQNO_統合監視DB内通し番号/_JP1IMEVBSEQNO_イベントDB内通し番号
2	value	Object[]	イベントの属性名と属性値の情報を配列で返却します。イベントに無い属性は，属性値に0バイトの文字列を返却します。 パラメーターvalueに返却されるイベントの属性名の一覧と属性値の形式は，時刻型のイベント属性※1とIPアドレスのイベント属性※2以外はDBの値となります。 時刻型のイベント属性の形式は，ISO 8601の拡張形式（YYYY−MM−DDThh:mm:ssTZD）に従います。 「イベント検索」APIを実行した場合は，リクエストのattrsパラメーターに指定したイベント属性が本メンバーとして返却されます。 「イベント詳細情報取得」APIを実行した場合は，イベント拡張属性定義ファイルの設定に従ったイベント属性が本メンバーとして返却されます。
3	title	Object[]	イベント属性名と属性の表示項目名の一覧を返却します。 このメンバーは，イベント詳細情報取得APIを実行した場合に返却されます。詳細については「5.6.2　イベント詳細情報取得」を参照してください。
4	type※3	Object[]	イベント属性名と属性値のタイプの一覧を返却します。 このメンバーは，イベント詳細情報取得APIを実行した場合に返却されます。詳細については「5.6.2イベント詳細情報取得」を参照してください。
5	monitor	Object[]	「イベント検索」API，「イベント詳細情報取得」APIを実行した場合，イベントを発行した連携製品のモニター画面呼び出し情報を返却します。詳細については「7.2.1(2)　イベントを発行した連携製品のモニター画面呼び出し情報オブジェクト」を参照してください。

注※1

時刻型のイベント属性とは，登録時刻（B.TIME），到着時刻（B.ARRIVEDTIME），開始時刻（E.START_TIME），終了時刻（E.END_TIME）のことです。ISO 8601の拡張形式（YYYY−MM−DDThh:mm:ssTZD）で出力されます。ただし，開始時刻（E.START_TIME），終了時刻（E.END_TIME）が数値以外の場合，0未満の数値，または2,147,483,648以上の数値の場合は，文字列として出力されます。

注※2

IPアドレスのイベント属性とは，発行元IPアドレス（B.SOURCEIPADDR），送信先IPアドレス（B.DESTIPADDR）のことです。

注※3

typeメンバーが返却する属性名と属性値について，次に示します。

項番	type	説明	イベント属性と返却するタイプの対応
1	なし	文字列 GUIはシングルラインのテキスト形式で表示されます。 制御文字（改行コードなど）は半角スペースに置き換わります。	text，html，date以外の属性
2	text	文字列 GUIはマルチラインのテキスト形式（＜pre＞タグ付き）で，表示されます。	メッセージ（B.MESSAGE） 変更後メッセージ（E.@JP1IM_DISPLAY_MESSAGE） メモ（E.@JP1IM_MEMO） テキスト形式のガイドメッセージ（E.@JP1IM_GUIDE）
3	html	htmlドキュメント GUIはHTML形式（＜iframe＞タグ付き）で，表示されます。	HTML形式のガイドメッセージ（E.@JP1IM_GUIDE）
4	date	日付データをISO8601形式（2004-04-01T12:00+09:00）にした文字列 GUIはクライアントのタイムゾーンに変換して（new Date（value）して）表示されます。	イベント拡張属性定義ファイルのattrステートメントに，次のどちらかが定義されている属性 type="elapsed_time/date_format:CLIENT" "elapsed_time_in_milli/date_format:CLIENT" JP1/IMのイベントでは，次に示す属性となります。 登録時刻（B.TIME） 到着時刻（B.ARRIVEDTIME） 開始時刻（E.START_TIME） 終了時刻（E.END_TIME） イベント拡張属性定義ファイルについては，「イベント拡張属性定義ファイル」（2.　定義ファイル）を参照してください。

重要

ガイドメッセージのイベント属性は，REST APIではIM属性（E.@JP1IM_GUIDE）として返却されます。表示項目名は日本語で「ガイド」，英語で「Guide」となります。

集約開始イベントのイベント属性

「イベント検索」APIのリクエストパラメーターconsolidateEventにtrueを指定した場合，集約開始イベントに次に示すイベント属性を設定します。集約開始イベント以外のイベントには設定されません。また，集約開始イベントのイベント属性は，jcoevtreportコマンドでは出力されません。

表7‒14　集約開始イベントのイベント属性

項番	属性名	説明
1	E.@JP1IM_CONSOLIDATION	集約開始イベントかどうかを示します。 1：集約開始イベント
2	E.@JP1IM_CONSOLIDATION_STATUS	集約開始イベントのステータスを示します。 10：異常なし/対処済 20：警告/通知/情報/デバッグ 30：エラー 40：緊急/警戒/致命的
3	E.@JP1IM_CONSOLIDATION_SEVERE_MIXED	集約イベントに重要イベントと重要ではないイベントが混在しているかどうかを示します。 0：混在していない 1：混在している
4	E.@JP1IM_CONSOLIDATION_DEALT_MIXED	集約イベントの対処状況が混在しているかどうかを示します。 0：混在していない 1：混在している
5	E.@JP1IM_CONSOLIDATION_ACTCONTROL_MIXED	集約イベントの自動アクションの状態が混在しているかどうかを示します。 0：混在していない 1：混在している

ページの先頭へ

(2)　イベントを発行した連携製品のモニター画面呼び出し情報オブジェクト

機能

連携製品のモニター画面呼び出し情報を表すオブジェクトです。

形式

{
   "url":"連携製品の画面URL"
}

メンバー

メンバーを次の表に示します。

表7‒15　イベントを発行した連携製品のモニター画面呼び出し情報オブジェクトのメンバー

項番	メンバー	データ型	説明
1	url	string	連携製品の画面URL

ページの先頭へ

(3)　イベント検索条件オブジェクト

機能

イベント検索条件を表すオブジェクトです。すべての除外条件群に一致しないイベント，かつ通過条件群のどれか1つに一致するイベントを取得対象のイベントと判断します。

形式

{
   "include":[通過条件群,…],
   "exclude":[除外条件群,…]
}

通過条件群，除外条件群の形式

通過条件群，除外条件群を配列で指定します。指定したイベント条件は，AND条件で判定します。

[
{ "key":"イベント属性名","ope":"比較条件","val":"オペランド" },…
]

メンバー

メンバーを次の表に示します。

表7‒16　イベント検索条件オブジェクトのメンバー

項番	メンバー	データ型	説明
1	include	Object[]	イベント検索条件の通過条件群を0〜5件の範囲で指定します。 通過条件群には0〜50件のイベント条件が指定できます。拡張属性（固有情報）のイベント条件は，1つの通過条件群に最大5件まで指定できます。
2	exclude	Object[]	イベント検索条件の除外条件群を0〜5件の範囲で指定します。 除外条件群には0〜50件のイベント条件が指定できます。拡張属性（固有情報）のイベント条件は，1つの除外条件群に最大5件まで指定できます。
3	key	String	比較したいイベント属性名を指定します。基本属性を指定する場合は，名称の前に「B.」を付けます。拡張属性（共通情報），拡張属性（固有情報）を指定する場合は，名称の前に「E.」を付けます。英大文字・英小文字を区別します。 指定できるイベント属性については，「表7-16 指定できる属性名と比較キーワードの組み合わせ」の「属性名」を参照してください。
4	ope	String	keyに指定したイベント属性の比較条件を指定します。比較条件には，「BEGIN（から始まる）」，「IN（と一致する）」，「NOTIN（と一致しない）」，「SUBSTR（を含む）」，「NOTSUBSTR（を含まない）」，「REGEX（正規表現）」，「TRANGE（日時指定）」のどれか一つを指定できます。英大文字・英小文字を区別します。 イベント属性ごとに指定できる比較条件については，「表7-16 指定できる属性名と比較キーワードの組み合わせ」の「比較キーワード」を参照してください。 時刻型のイベント属性※の比較条件については，「表7-17 時刻型のイベント属性の比較条件」および「表7-18 時刻型のイベント属性一覧」を参照してください。
5	val	keyに依存	keyに指定したイベント属性の比較値（オペランド）を指定します。英大文字・英小文字を区別します。複数指定が可能なオペランドについては，配列の形式で指定します。複数指定したオペランドはOR条件となります。ただし，比較キーワードに正規表現を指定している場合は，複数指定できません。 複数指定可能なオペランドでも空の配列または要素にnullが指定された配列は指定できません。 オペランドに，半角スペース，タブ，改行コード（CR，LF）および%を指定したい場合，次のように記述します。 半角スペース（0x20）：%20 タブ（0x09）：%09 改行コード LF（0x0a）：%0a 改行コード CR（0x0d）：%0d %（0x25）：%25 オペランドは，イベント条件1 件当たり4,096バイトまで，イベント条件ブロック1件当たり4,096バイト（イベント条件ブロックに記述したオペランドの合計バイト数）まで指定できます。 イベント属性ごとに指定できる比較値（オペランド）は，「表7-16 指定できる属性名と比較キーワードの組み合わせ」の「オペランド」を参照してください。 複数指定が可能なオペランドについては，配列の形式で指定します。

注※

時刻型のイベント属性とは，登録時刻（B.TIME），到着時刻（B.ARRIVEDTIME），開始時刻（E.START_TIME），終了時刻（E.END_TIME）のことです。

表7‒17　指定できる属性名と比較キーワードの組み合わせ

項番	種別	属性名	型	指定できる比較キーワード	オペランド
1	基本属性	イベントID （B.ID）	数値	と一致する と一致しない	複数指定できる。複数指定では最大100件指定できる。 16進数形式で指定する。大文字・小文字は区別しない。ただし，正規表現では大文字・小文字を区別する。 指定できる範囲は0〜7FFFFFFFである。
2		登録要因 （B.REASON）	数値	と一致する と一致しない	複数指定できる。複数指定では最大100件指定できる。
3		発行元プロセスID （B.PROCESSID）	数値	と一致する と一致しない	複数指定できる。複数指定では最大100件指定できる。 指定できる範囲は，-2147483648〜2147483647である。
4		発行元ユーザーID （B.USERID）	数値	と一致する と一致しない	複数指定できる。複数指定では最大100件指定できる。 指定できる範囲は，-2147483648〜2147483647である。
5		発行元グループID （B.GROUPID）	数値
6		発行元ユーザー名 （B.USERNAME）	文字列	から始まる と一致する と一致しない を含む を含まない 正規表現	複数指定できる。複数指定では最大100件指定できる。ただし，正規表現を指定した場合は，複数指定できない。
7		発行元グループ名 （B.GROUPNAME）	文字列
8		発行元イベントサーバ名 （B.SOURCESERVER）	文字列
9		送信先イベントサーバ名 （B.DESTSERVER）	文字列
10		メッセージ （B.MESSAGE）	文字列	から始まる と一致する と一致しない を含む を含まない 正規表現	複数指定できる。複数指定では最大100件指定できる。ただし，正規表現を指定した場合は，複数指定できない。
11		登録時刻 （B.TIME）	時刻	日時指定	範囲開始日時および範囲終了日時を指定する。 範囲開始日時≦時刻≦範囲終了日時が成立する場合に一致する。
12		到着時刻 （B.ARRIVEDTIME）	時刻	日時指定
13	拡張属性（共通情報）	重大度 （E.SEVERITY）	文字列	と一致する	複数指定できる。ただし，重複した重大度は指定できない。 "Emergency"，"Alert"，"Critical"，"Error"，"Warning"，"Notice"，"Information"，"Debug"のどれかを指定できる。
14		ユーザー名 （E.USER_NAME）	文字列	から始まる と一致する と一致しない を含む を含まない 正規表現	複数指定できる。複数指定では最大100件指定できる。ただし，正規表現を指定した場合は，複数指定できない。
15		プロダクト名 （E.PRODUCT_NAME）	文字列
16		オブジェクトタイプ （E.OBJECT_TYPE）	文字列
17		オブジェクト名 （E.OBJECT_NAME）	文字列
18		登録名タイプ （E.ROOT_OBJECT_TYPE）	文字列
19		登録名 （E.ROOT_OBJECT_NAME）	文字列
20		オブジェクトID （E.OBJECT_ID）	文字列
21		事象種別 （E.OCCURRENCE）	文字列
22		開始時刻 （E.START_TIME）	文字列	日時指定	範囲開始日時および範囲終了日時を指定する。 範囲開始日時≦時刻≦範囲終了日時が成立する場合に一致する。
23		終了時刻 （E.END_TIME）	文字列	日時指定
24		終了コード （E.RESULT_CODE）	文字列	から始まる と一致する と一致しない を含む を含まない 正規表現	複数指定できる。複数指定では最大100件指定できる。ただし，正規表現を指定した場合は，複数指定できない。
25		発生元ホスト名 （E.JP1_SOURCEHOST）	文字列
26	拡張属性（固有情報）	E.*属性	文字列	から始まる と一致する と一致しない を含む を含まない 正規表現	属性名には，先頭が英大文字で英大文字，数字，およびアンダーバー（_）から構成される32バイトまでの名称を設定できる。 複数指定できる。複数指定では最大100件指定できる。ただし，正規表現を指定した場合は，複数指定できない。
27	IM属性	アクション種別 （E.@JP1IM_ACTTYPE）	数値	と一致する と一致しない	次の数値を指定できる。 0（アクション対象外） 1（コマンド） 2（ルール） 3（コマンド,ルール） 複数指定できる。
28		アクション抑止 （E.@JP1IM_ACTCONTROL）	数値		次の数値を指定できる。 0（アクション対象外） 1（実行） 2（抑止） 3（一部抑止） 複数指定できる。
29		重要イベント （E.@JP1IM_SEVERE）	数値		次の数値を指定できる。 0（重要イベントではない） 1（重要イベント） 複数指定できる。
30		相関イベント （E.@JP1IM_CORRELATE）	数値		次の数値を指定できる。 0（相関イベントではない） 1（相関成立イベント） 2（相関不成立イベント） 複数指定できる。
31		応答待ちイベント （E.@JP1IM_RESPONSE）	数値		次の数値を指定できる。 0（応答待ちイベントではない） 1（応答待ちイベント） 複数指定できる。
32		重大度（変更前） （E.@JP1IM_ORIGINAL_SEVERITY）	文字列	から始まる と一致する と一致しない を含む を含まない 正規表現	複数指定できる。複数指定では最大100件指定できる。ただし，正規表現では複数指定はできない。
33		重大度変更 （E.@JP1IM_CHANGE_SEVERITY）	数値	と一致する と一致しない	次の数値を指定できる。 0（重大度変更なし） 1（重大度変更あり） 複数指定できる。
34		対処状況 （E.@JP1IM_DEALT）	数値		次の数値を指定できる。 0（未対処） 1（対処済） 2（処理中） 3（保留） 複数指定できる。
35		重要イベント解除 （E.@JP1IM_RELEASE）	数値		次の数値を指定できる。 0（重要イベントを解除していない） 1（重要イベントを解除している） 複数指定できる。
36		重要イベント削除 （E.@JP1IM_DISMISSED）	数値		次の数値を指定できる。 0（重要イベントを削除していない） 1（重要イベントを削除している） 複数指定できる。
37		メモ （E.@JP1IM_MEMO）	文字列	から始まる と一致する と一致しない を含む を含まない 正規表現	複数指定できる。複数指定では最大100件指定できる。ただし，正規表現を指定した場合は，複数指定できない。
38		メッセージ（変更後） （E.@JP1IM_DISPLAY_MESSAGE）	文字列	から始まる と一致する と一致しない を含む を含まない 正規表現	複数指定できる。複数指定では最大100件指定できる。ただし，正規表現を指定した場合は，複数指定できない。
39		表示メッセージ変更（E.@JP1IM_CHANGE_MESSAGE）	数値	と一致する と一致しない	指定できる範囲は，-2147483648〜2147483647である。
40		表示メッセージ変更定義名（E.@JP1IM_CHANGE_MESSAGE_NAME）	文字列	から始まる と一致する と一致しない を含む を含まない 正規表現	複数指定できる。複数指定では最大100件指定できる。ただし，正規表現を指定した場合は，複数指定できない。

（凡例）

×：比較できない

−：対象外

表7‒18　時刻型のイベント属性の比較条件

項番	比較キーワード	データ型	説明
1	日時指定 （TRANGE）	開始日時と終了日時を指定	JP1イベントの属性値（時刻型）が，オペランドの開始日時と終了日時の範囲に含まれる場合，イベント条件と一致したとみなされます。 オペランドはISO 8601の拡張形式で指定します。 指定できる範囲 開始日時≦属性値≦終了日時 指定形式 YYYY−MM−DDThh:mm:ssTZD 指定例 2018年3月1日から3月31日の範囲を指定する場合 {"key":"B.TIME","ope":"TRANGE","val": ["2018−03−01T00:00:00+09:00", "2018−03−31T00:00:00+09:00"]}

表7‒19　時刻型のイベント属性一覧

項番	種別	属性名	型	指定できる比較キーワード	オペランド
1	基本属性	登録時刻 （B.TIME）	時刻	日時指定	オペランドの指定形式は「表7-17 時刻型のイベント属性の比較条件」と同じです。
2		到着時刻 （B.ARRIVEDTIME）	時刻	日時指定
3	拡張属性	開始時刻 （E.START_TIME）	時刻	日時指定
4		終了時刻 （E.END_TIME）	時刻

ページの先頭へ