5.13.2　対処アクション提案

機能

指定したIM管理ノード，提案IDに応じた提案定義について，提案が活性化する条件を判定し，システム状況に応じた対処アクションを提案します。

実行権限

JP1_Console_Admin
JP1_Console_Operator
JP1_Console_User

APIのバージョン

形式

リクエスト行

POST /application/component/apivVersion/nodes/suggestions/suggest httpVersion

リクエストのメッセージボディー

{
    "sid": IM管理ノードのツリーSID,
    "suggestionIds": 提案IDのリスト
}

レスポンスのメッセージボディー

{
    "suggestions":[
        {
            "suggestionId": 提案ID,
            "label": 提案表示名,
            "status": 提案活性条件が成立したか,
            "cases":[
                [
                    {
                        "description": 条件の説明,
                        "status": 条件の状態,
                        "acquisitionDate": 取得日時,
                    },
                    ...
                ],
                [
                    {
                        "description": 条件の説明,
                        "status": 条件の状態,
                        "acquisitionDate": 取得日時,
                    },
                ...
            ],
            "action": {
                    "type": 対処アクションの種別,
                    "params": 対処アクションのパラメーター,
                    "description": 対処アクションの説明
                      }
            "messageList":[
                {
                    "messageId": メッセージID,
                    "message": メッセージ文
                },
                ...
            ]
        },
        ...
    ]
}

パラメーター

sid

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

suggestionIds

提案IDのリストを指定します。1〜1,000件まで指定できます。空のリストを指定した場合，エラーメッセージKAJY22019-Eを出力し，対処アクションの提案処理を中断します。

このパラメーターの指定を省略した場合は，指定したIM管理ノードにマッピングされた提案定義のうち，ログインユーザーが表示できる提案定義について，提案活性条件を判定し，システム状況に応じた対処アクションの提案情報を取得します。

指定されたIM管理ノードのツリーSIDにマッピングされていない提案定義，またはログインユーザーが表示できない提案定義の提案IDを指定した場合，エラーメッセージKAJY22021-Eを出力し，対処アクションの提案処理の取得を中断します。

ステータスコード

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

ステータスコード	メッセージ	説明
200	なし	対処アクションの提案に成功しました。
	KAJY22026-W	提案定義の変数変換に失敗しました。
	KAJY22027-W	提案定義を変数変換したあとの提案情報が不正です。
	KAJY22028-W	提案活性条件の判定に失敗しました。
	KAJY22047-W	繰り返しイベント一覧画面の情報の取得に失敗しました。
400	KAJY22020-E	REST APIのリクエストが不正です。 IM管理ノードのツリーSIDの形式が不正，提案IDが不正，提案IDのリスト数が不正，などの原因が考えられます。
	KAJY22022-E	REST APIのリクエストが不正です。提案IDが重複しています。
	KAJY22011-E	存在しないツリーSIDを指定しているか，指定したIM管理ノードの参照権限がログインユーザーにありません。
	KAJY22021-E	指定されたIM管理ノードにマッピングされていない提案，またはログインユーザーが表示できない提案の提案IDを指定しています。
403	KAJY01000-E	REST APIの実行権限がありません。

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

項番	メンバー名				データ型	説明
1	`suggestions`				object[]	取得した提案情報を配列として返却します。指定されたIM管理ノードのツリーSIDにマッピングされている提案定義が存在しない，またはマッピングされている提案定義の中に，ログインユーザーが表示できる提案定義が存在しない場合は，空の配列が返却されます。
2		`suggestionId`			string	提案IDが設定されます。
3		`label`			string	提案表示名が設定されます。
4		`status`			int	提案活性条件が成立したかどうかです。次のどれかを返却します。 `0`：条件成立 1：条件不成立 2：エラー
5		`cases`			object[][]	提案条件オブジェクトの二重配列が設定されます。内側の配列がAND条件群，外側の配列がOR条件群を表します。提案定義の`cases`メンバーを省略した場合，このメンバーは返却されません。
6			`description`		string	変数を変換したあとの条件の説明が返却されます。
7			`status`		int	条件の状態です。次のどれかを返却します。 `0`：未判定 `1`：一致 `2`：不一致 `3`：エラー
8			`acquisitionDate`		string	条件情報の取得日時をISO 8601形式のUTC時刻で返却します。 `status（`条件の状態）が`0`（未判定），または`3`（エラー）の場合は，空文字が返却されます。
9		`action`			object	対処アクションの情報が返却されます。
10			`type`		string	提案定義に指定された対処アクションの種別が返却されます。`type`のメンバーの詳細については「提案定義ファイル」（2.　定義ファイル）の「(2)対処アクション」を参照してください。
11			`params`		object	対処アクションの`type`に`jump`が指定され，かつ`relatedEvent`が指定されている場合は`redlatedEvent`および項番12〜項番15のメンバーが返却されます。その他の場合は，提案定義に指定された対処アクションのパラメーターが変数を変換された状態で返却されます。項番12〜項番15以外のメンバーの詳細については「提案定義ファイル」（2.　定義ファイル）の「(2) 対処アクション」を参照してください。
12				`suppressId`	string	`relatedEvent`^※で指定されたJP1イベントの属性E.JP1_IMSUPPRESS_ID（監視抑止ID）の値です。
13				`eventSevere`	string	`relatedEvent`^※で指定されたJP1イベントの属性E.@JP1IM_SEVERE（重要イベント）の値です。
14				`suppressName`	string	`relatedEvent`^※で指定されたJP1イベントの属性E.JP1_IMSUPPRESS_NAME（繰り返しイベント条件名）の値です。
15				`nodeSid`	string	`relatedEvent`^※で指定されたJP1イベントに対応するIM管理ノードのツリーSIDです。
16			`description`		string	`status（提案活性条件の成立）`が`0`（条件成立）の場合変数を変換したあとの対処アクションの説明が返却されます。 `status`が上記以外の場合変数を変換する前の対処アクションの説明が返却されます。512文字を超える場合は，513文字目以降は削除されます。
17		`messageList`			object[]	処理中に発生した続行が可能な警告メッセージを返却しましす。続行が可能な警告メッセージがない場合，このメンバーは返却されません。
18			`messageId`		string	メッセージIDが返却されます。
19			`message`		string	メッセージ文が返却されます。

注※: relatedEventの詳細については「提案定義ファイル」（2.　定義ファイル）の「(2)(A)(e) typeに「jump」を指定した場合の対処アクション」のrelatedEventの説明を参照してください。

使用例

管理オブジェクトであるPFMエージェントのサービスのIM管理ノード（ツリーsid：_ROOT_AllSystems/_HOST_HOST1/_CATEGORY_platform/_SUBCATEGORY_JP1%2FPFM%20-%20Windows/_OBJECT_JP1PFM-ATA1HOST2）の対処アクションを提案する場合の使用例を次に示します。

リクエスト：

POST http://hostname:20703/im/api/v1/nodes/suggestions/suggest
{
"sid":"_ROOT_AllSystems/_HOST_HOST1/_CATEGORY_platform/_SUBCATEGORY_JP1%2FPFM%20-%20Windows/_OBJECT_JP1PFM-ATA1HOST2"
}

レスポンス：

HTTP/1.1 200 OK
Content-Type: application/json
{
    "suggestions":[
        {
            "suggestionId":"check_affected_rootJobnet",
            "label":"ホスト停止に影響されるルートジョブネットの影響",
            "status":0,
            "cases":[
                [
                    {
                         "description":"選択中のノード(PFM-Agent)と同じホストにJP1/AJS-Agentのノードが存在する",
                         "status":1,
                         "acquisitionDate":"2020-03-11T11:00:00Z"
                    },
                    {
                         "description":"ホスト停止のJP1イベントが発行されている",
                        "status"：1,
                         "acquisitionDate":"2020-03-11T11:00:01Z"
                    },
                    {
                         "description":"選択ノードのホストが停止している",
                         "status"：1,
                         "acquisitionDate":"2020-03-11T11:00:02Z"
                    }
                ]
            ],
            "action":
                {
                    "type":"jump",
                    "params":
                        {
                            " url":"index?sid=%5FROOT%5FAllSystems%2F%5FHOST%5FHOST1%2F%5FCATEGORY%5FmanagementApplications%2F%5FOBJECT%5FJP1AJSAGT&view=tree&tab=relation&eou=1"
                        },
                    "description":"JP1/AJS-Agentのノードの関連ノードタブに移動"
                }
        }
    ]
}

ページの先頭へ

5.13.2 対処アクション提案

5.13.2　対処アクション提案