4.5.13 jp1EmService.getEvent
IM管理ノードに関連するイベントを,統合監視DBから取得するメソッドです。パラメーターで指定した条件に合致するイベントの一覧を取得します。
このメソッドを指定したJP1ユーザーに参照権限が無いイベントは,取得できません。また,その際,エラーメッセージは出力されません。
取得できるイベントの範囲は,JP1資源グループの設定,およびJP1/IM - Managerのユーザーフィルターの設定に従います。参照できるイベントの条件については,マニュアル「JP1/Integrated Management 3 - Manager 導入・設計ガイド」の「3.5.1 IM管理ノードの構造」のIM管理ノードを選択した際に,イベントビューに表示できるイベントの説明を参照してください。
なお,このメソッドは製品プラグインの__eventGetメソッド,および__eventGetメソッドの呼び出し先のメソッドからは,呼び出しできません。
jp1EmService.getEventメソッドの詳細を次に示します。
- メソッド名
-
Object jp1EmService.getEvent(String sid, Object filter, String direction, String since, int count, String[] attrs, int[] statusFilter, boolean consolidateEvent, int searchCount, String lang, String jp1User, String jp1Token)
- パラメーター
-
- sid
-
IM管理ノードのツリーSIDを指定します。指定したIM管理ノードが発生元となるイベントの一覧を取得します。
nullまたは空文字を指定した場合は,オールシステム(_ROOT_AllSystems)を指定したものと仮定されます。なお,IM管理ノードがセットアップされていない状態でnullまたは空文字を指定した場合は,空のイベント一覧が返却されます。
- filter
-
イベント検索条件オブジェクトを指定します。
指定したイベント検索条件に従い,統合監視DBからイベントを検索します。イベント検索オブジェクトについては,「7.2.1(3) イベント検索条件オブジェクト」を参照してください。ただし,各属性の値に半角スペースを指定した場合は「%20」を指定したものとみなされます。
sidで指定したイベントを,filterで指定したイベント検索条件で絞り込みます。絞り込みが不要な場合は,nullを指定します。
通過条件群にkeyがB.TIME(登録時刻)でopeがTRANGE(日時指定)のイベント条件を指定していない,かつkeyがB.ARRIVEDTIME(到着時刻)でopeがTRANGE(日時指定)のイベント条件を指定していない場合※は,通過条件群の一つとして以下を指定したものと仮定されます。
{"key":"B.TIME","ope":"TRANGE","val":["現在時刻の1日前","現在時刻"]}
注※ filterにnullを指定した場合も含まれます。
なお,keyにB.ID(イベントID)を指定したイベント条件のvalの指定値の桁数は,自動でゼロ埋めされます。
- direction
-
イベントの検索方向を指定します。
過去方向は「past」,未来方向は「future」を指定します。nullまたは空文字を指定した場合は「past」を指定したものと仮定されます。
- since
-
イベントの検索開始位置をJP1イベントのSIDで指定します。指定したJP1イベントのSIDより未来または過去のイベントを検索します。ただし,指定したJP1イベントのSIDのイベントは検索対象に含みません。nullまたは空文字を指定した場合は,directionの指定に従って,統合監視DBの先頭または末尾から検索を開始します。JP1イベントのSIDの詳細については「7.2.1(1) イベント情報オブジェクト」を参照してください。
- count
-
イベントの最大取得件数を1〜2,000件の範囲で指定します。
- attrs
-
取得したいイベント属性の項目を配列で指定します。
(指定例)
“attrs”:[”B.ID”,”B.MESSAGE”,…]
attrsに指定した属性をユーザーが指定した並び順で取得します。nullを指定した場合は,指定したJP1イベントによって次のようになります。
-
集約開始イベントの場合
イベントレポート出力機能の属性値の出力項目を,すべて取得します。そのあと,「7.2.1(1) イベント情報オブジェクト」の「集約開始イベントのイベント属性」の表に示す属性を取得します。
-
その他のイベントの場合
イベントレポート出力機能の属性値の出力項目を,すべて取得します。指定できるイベント属性は,イベントレポート出力機能で出力できるすべての属性,および「7.2.1(1) イベント情報オブジェクト」の「集約開始イベントのイベント属性」の表に示す属性です。
イベントレポート出力機能の詳細については,マニュアル「JP1/Integrated Management 3 - Manager 導入・設計ガイド」の「4.15.2 統合監視DBのイベント情報を保管(イベントレポート出力)」を参照してください。
-
- statusFilter
-
ノードのステータスに該当するイベントだけを絞り込む場合は,intの配列でステータス値を指定します。
(指定例)ノードのステータスが30と40のイベントだけを取得したい場合
"statusFilter":[30,40]
ノードのステータスコードについては,「5.8.5 IM管理ノードステータス取得」を参照してください。絞り込みが不要な場合は,nullを指定します。
- consolidateEvent
-
インテリジェント統合管理基盤で繰り返しイベントが集約されている場合に,集約された繰り返しイベントを返却するかどうかを指定します。繰り返しイベントの返却を抑止する場合は,「true」を指定します。
-
true
インテリジェント統合管理基盤で繰り返しイベントの表示が抑止されている場合,集約開始イベントだけを返却します。集約開始イベントよりあとの繰り返しイベントは返却しません。
-
false
インテリジェント統合管理基盤で繰り返しイベントの表示が抑止されているかどうかに関わらず,繰り返しイベントを返却します。
-
- searchCount
-
イベントの検索回数の上限を0〜120,000の範囲で指定します。
sidパラメーターで指定したIM管理ノードにマッピングされているイベントを,sinceパラメーターの検索開始位置からdirectionパラメーターの検索方向に向かって,100件分検索します。
ユーザーフィルターなどによって,countパラメーターで指定した件数のイベントが取得できない場合は,次のイベント100件を対象として繰り返し検索します。この繰り返し行うイベント検索回数の上限値を指定します。
検索回数が上限値に達した場合は検索を中断し,中断までに取得できたイベントの一覧,およびKAJY32010-Wのメッセージを出力します。指定を省略した場合,値に「0」を指定した場合は,検索回数は制限されません。
- lang
-
メッセージの言語を指定します。「ja」,「ja-JP」または「en」を指定できます。その他の値を指定した場合は「en」を指定したものと仮定されます。詳細は「4.4 実装可能なメソッド」の「ユーザー作成プラグインの言語規約」を参照してください。
- jp1User
-
次のJP1権限レベルが設定されたJP1ユーザー名を,1〜31バイトの範囲で指定します。指定されたJP1ユーザーに参照権限があるイベントが取得されます。
-
JP1_Console_Admin
-
JP1_Console_Operator
-
JP1_Console_User
-
- jp1Token
-
jp1Userで指定したJP1ユーザーに対応するJP1認証トークンを指定します。
- 戻り値
-
イベント取得に成功した場合は,イベントの情報を格納したオブジェクトが返却されます。イベント取得に成功した場合にオブジェクトに格納されるキーと値を,次に示します。
項番
キー
値
1
eventData
取得したイベントの一覧をイベント情報オブジェクトの配列として返却します。イベント情報オブジェクトについては「7.2.1(1) イベント情報オブジェクト」を参照してください。イベントが一つも存在しない場合は,要素数0の配列を返却します。
2
messageId
イベント検索の途中で発生した一時的なエラーのメッセージIDを返却します。KAJY32005-WまたはKAJY32010-Wが返却されます。通知すべきメッセージがない場合はnullを指定します。メッセージの詳細については,マニュアル「JP1/Integrated Management 3 - Manager メッセージ」を参照してください。
3
message
イベント検索の途中で発生した一時的なエラーメッセージのメッセージ本文を返却します。通知すべきメッセージがない場合はnullを指定します。
4
beginSid
sinceパラメーターで指定したイベントの検索開始位置の次のJP1イベントのSIDを返却します。sinceパラメーターからイベント取得方向に向かって,一つ先のJP1イベントのSIDです。検索対象となるJP1イベントが一つも存在しない場合は省略されます。
5
endSid
イベントの検索終了位置のJP1イベントのSIDを返却します。イベント検索の中断が発生した場合は,中断位置のJP1イベントのSIDが返却されます。検索対象となるイベントが一つも存在しない場合は省略されます。
イベント取得に失敗した場合にオブジェクトに格納されるキーと値を,次に示します。
項番
キー
値
1
errorMessage
エラーメッセージです。引数が不正な場合はKAJY22043-Eのエラーメッセージが設定されます。JP1/IM3-Managerサービス停止中にこのメソッドを実行した場合はKAJY32000-Eのメッセージが設定されます。その他の場合に設定されるエラーメッセージについては,「5.6.1 イベント検索」のステータスコードを参照してください。
2
errorMessageId
エラーメッセージのidを返却します。
このメソッドを呼び出す製品プラグインのメソッドは,キーerrorMessageIdの値に応じて,プラグインの仕様に基づいたエラーメッセージやエラー処理を検討してください。
キーerrorMessageは製品プラグインの内部ログに出力し,製品プラグインの障害調査に活用してください。
- 例外
-
なし