Hitachi

JP1 Version 12　JP1/Integrated Management 2 - Manager コマンド・定義ファイル・APIリファレンス

5.6.1　イベント検索

機能

IM管理ノードに関連するイベントを，統合監視DBから取得します。

イベント検索条件をパラメーターとして指定した場合は，検索条件に一致したイベントの一覧を取得します。

ログインしたJP1ユーザーに参照権限が無いイベントは取得できません。また，エラーにもなりません。

取得できるイベントの範囲は，JP1資源グループの設定，およびJP1/IM - Managerのユーザーフィルターの設定に従います。

実行権限

  • JP1_Console_Admin

  • JP1_Console_Operator

  • JP1_Console_User

APIのバージョン

v1

形式
リクエスト行
POST /application/component/apiVersion/nodes/treeInfo/event httpVersion
リクエストのメッセージボディー
{
    "sid":"IM管理ノードのツリーのSID",
    "filter":"イベント検索条件",
    "direction":"イベント取得方向",
    "since":"イベントの取得開始位置",
    "count":"イベント取得件数",
    "attrs":"取得するイベント属性の一覧",
    "statusFilter":"ステータスフィルター",
    "consolidateEvent":"集約された繰り返しイベントを返却するかどうか",
    "searchCount":"イベントの検索回数"
}
レスポンスのメッセージボディー
{
  "eventData":[
    イベント情報オブジェクト,…
  ],
  "messageId":"メッセージID",
  "message":"メッセージ",
  "beginSid":"イベントの検索開始位置の次のJP1イベントのSID",
  "endSid":"イベントの検索終了位置のJP1イベントのSID"
}
パラメーター
sid

IM管理ノードのツリーのSIDを，string型で指定します。

指定したIM管理ノードが発生元となるイベントの一覧を取得します。省略した場合は，オールシステム（_ROOT_AllSystems）を指定したと仮定されます。IM管理ノードがセットアップされていない状態で，このパラメーターを省略した場合は，空のイベント一覧を返却します。

filter

イベント検索条件オブジェクトを指定します。

指定したイベント検索条件に従い，統合監視DBからイベントを検索します。イベント検索オブジェクトの詳細は「7.2.1(3)　イベント検索条件オブジェクト」を参照してください。

sidパラメーターの対象となるイベントを，filterパラメーターで指定したイベント検索条件で絞り込みます。

direction

イベントの検索方向を，次の値で指定します。

  • 過去方向：past

  • 未来方向：future

指定を省略した場合は「past」を仮定します。

since

イベントの検索開始位置をJP1イベントのSIDで指定します。指定したJP1イベントのSIDより未来または過去のイベントを検索します。ただし，指定したJP1イベントのSIDのイベントは検索対象に含みません。

指定を省略した場合は，directionパラメーターに従い，統合監視DBの先頭あるいは末尾から検索を開始します。

JP1イベントのSIDの詳細は「7.2.1(1)　イベント情報オブジェクト」を参照してください。

count

イベントの最大取得件数を1〜2,000件の範囲で指定します。指定を省略した場合は，2,000件を仮定します。

attrs

取得したいイベント属性の項目を配列で指定します。このパラメーターに指定した属性を，ユーザーが指定した並び順で取得します。

指定例

"attrs":["B.ID","B.MESSAGE",…]

指定を省略した場合は，イベントレポート出力機能で出力できるすべての属性，および「7.2.1(1)　イベント情報オブジェクト」の「集約開始イベントのイベント属性」の表に示す属性を取得します。

イベントレポート出力機能の詳細については，マニュアル「JP1/Integrated Management 2 - Manager 導入・設計ガイド」の「4.15.2　統合監視DBのイベント情報を保管（イベントレポート出力）」を参照してください。

statusFilter

IM管理ノードのステータスを該当するイベントだけで絞り込みする場合に，intの配列でステータスの値を指定します。IM管理ノードのステータスについては「5.8.3　IM管理ノードステータス取得」を参照してください。

指定例：ステータスが「30」と「40」のイベントだけを取得する場合

"statusFilter":[30,40]
consolidateEvent

繰り返しイベントが集約されている場合に，集約された繰り返しイベントを返却するかどうかを指定します。指定を省略した場合は，「false」を仮定します。繰り返しイベントの返却を抑止する場合は，「true」を指定します。

  • true：インテリジェント統合管理基盤で繰り返しイベントの表示が抑止されている場合，集約開始イベントだけを返却します。集約開始イベントよりあとの繰り返しイベントは返却しません。

  • false：インテリジェント統合管理基盤で繰り返しイベントの表示が抑止されているかどうかに関わらず，繰り返しイベントを返却します。

searchCount

イベントの検索回数の上限を0〜120,000の範囲で指定します。

sidパラメーターで指定したIM管理ノードにマッピングされているイベントを，sinceパラメーターの検索開始位置からdirectionパラメーターの検索方向に向かって，100件分検索します。ユーザーフィルターなどによって，countパラメーターで指定した件数のイベントが取得できない場合は，次のイベント100件を対象として繰り返し検索します。この繰り返し行うイベント検索回数の上限値を指定します。

検索回数が上限値に達した場合は検索を中断し，中断までに取得できたイベントの一覧を返却します。指定を省略した場合，値に「0」を指定した場合は，検索回数は制限されません。

ステータスコード

リクエストに対するレスポンスとして返却されるステータスコードを，次の表に示します。

ステータスコード

メッセージ

説明

200

なし

イベント一覧の取得に成功しました。

KAJY32005-W

イベント検索の途中で一時的なエラーが発生しました。

KAJY32010-W

イベントの取得時のイベント検索が指定された検索回数上限に達したため，イベント取得を中断しました。

400

KAJY32200-E

リクエストのパラメーター指定形式が不正です。

KAJY32201-E

イベント検索条件（filterパラメーター）の記述が不正です。

404

KAJY32202-E

指定したノードがマネージャーに存在しません。

500

KAJY32000-E

〜

KAJY32004-E

KAJY32006-E

イベント検索処理中にエラーが発生しました。

メッセージの詳細については，マニュアル「JP1/Integrated Management 2 - Manager メッセージ」を参照してください。

戻り値

ステータスコードが200の場合に，レスポンスボディーに次の情報を返却します。

項番

メンバー名

データ型

説明

1

eventData

Object[]

取得したイベントの一覧を，イベント情報オブジェクトの配列として返却します。イベント情報オブジェクトについては「7.2.1(1)　イベント情報オブジェクト」を参照してください。

1つも存在しない場合は，要素数0の配列を返却します。

2

messageId

string

イベント検索の途中で発生した一時的なエラーメッセージのメッセージIDを返却します。通知すべきメッセージが無い場合は省略されます。

3

message

string

イベント検索の途中で発生した一時的なエラーメッセージのメッセージ本文を返却します。通知すべきメッセージが無い場合は省略されます。

4

beginSid

string

イベントの検索開始位置の次のJP1イベントのSIDを返却します。sinceからイベント取得方向に向かって1つ先のJP1イベントのSIDです。

検索対象となるイベントが1つも存在しない場合は省略されます。

5

endSid

string

イベントの検索終了位置のJP1イベントのSIDを返却します。イベント検索の中断が発生した場合は，中断位置のJP1イベントのSIDが返却されます。

検索対象となるイベントが1つも存在しない場合は省略されます。
使用例1

JP1/AJSのジョブグループに関連するイベントの一覧を取得する場合のAPIの使用例を次に示します。

POST /im/api/v1/nodes/treeInfo/event HTTP/1.1
Authorization:Bearer xxxx
Accept-Language: ja
Content-Type: application/json
Accept: application/json
 
{
    "sid": "_ROOT_AllSystems/_SYSTEM_System1/_SYSTEM_SubSystem1/_HOST_host1/_CATEGORY_Job/_SUBCATEGORY_JP1%2FAJS3%20-%20Manager/_OBJECT_ScheduleServ/_OBJECT_jobgroup",
"direction": "past",
"count": "200",
"attrs": [ "B.ID","E.@JP1IM_DEALT","E.SEVERITY" ]
}
使用例2

イベント検索条件を指定してイベントの一覧を取得する場合のAPIの使用例を次に示します。

リクエスト：
POST /im/api/v1/nodes/treeInfo/event HTTP/1.1
Authorization:Bearer xxxx
Accept-Language: ja
Content-Type: application/json
Accept: application/json
 
{
    "filter": {
        "include": [
            [
            {"key":"E.SEVERITY","ope":"IN","val": ["Error","Warning"] },
             {"key":"B.SOURCESERVER","ope":"IN","val":["host1","host2","host3"]}
            ],
            [
            {"key":"E.SEVERITY","ope":"IN","val": ["Error","Warning","Notice"] },
            {"key":"B.SOURCESERVER","ope":"IN","val":["host4","host5"]}
            ]
        ],
        "exclude": [
            [
                {"key":"E.@JP1IM_DEALT","ope":"IN","val":"1"}
            ]
        ]
    }
}
レスポンス：
HTTP/1.1 200 OK
Cache-Control: no-store, no-cache, max-age=0
Pragma: no-cache
Expires: Thu, 01 Jan 1970 00:00:00 GMT
Content-Type: application/json
 
{
    "eventData": [
    {
        "sid": "_JP1IM_imhost1/_JP1IMSEQNO_698/_JP1IMEVBSEQNO_747",
        "value": [
            "B.ID": "00004104",
            "E.@JP1IM_DEALT": "0",
            "E.SEVERITY": "Error"
    },
    {
        "sid": "_JP1IM_imhost1/_JP1IMSEQNO_697/_JP1IMEVBSEQNO_746",
        "value": [
            "B.ID": "00004107",
            "E.@JP1IM_DEALT": "0",
            "E.SEVERITY": "Error"
    }
    ]
}

ページの先頭へ

Copyright (C) 2019, 2021, Hitachi, Ltd.

Copyright (C) 2019, 2021, Hitachi Solutions, Ltd.