jp1pfmSuggestionSetStatusOfEventsToProcessed
機能
JP1イベントの対処状況を「対処済」に変更する関数です。
前提バージョン
-
PFM - ManagerおよびPFM - Web Console：12-00以降
-
JP1/IM2：12-50以降
提案定義ファイルでの指定方法
提案活性条件と対処アクションに指定する次のオブジェクトのメンバーに，必要な値を指定します。
-
提案活性条件のtypeが「plugin」のkeyオブジェクト
-
対処アクションのtypeが「plugin」のparamsオブジェクト
指定する値を，次の表に示します。
|
項番 |
メンバー名 |
データ型 |
省略可否 |
説明 |
|
|---|---|---|---|---|---|
|
1 |
sid |
string |
不可 |
Performance ManagementのIM管理ノードのツリーIDを指定します。 ツリーIDの指定方法については，「提案定義ファイル（imdd_suggestion_任意の文字列.conf）の設定項目」を参照してください。 |
|
|
2 |
method |
string |
不可 |
"jp1pfmSuggestionSetStatusOfEventsToProcessed"を指定します。 |
|
|
3 |
args |
object |
不可 |
項番4のメンバーを持つオブジェクトを指定します。 |
|
|
4 |
eventSids |
string |
不可 |
イベントのSIDの配列をJSON形式にした値を指定します。 正常に回復しているJP1イベントの対処状況を「対処済」に変更する場合，jp1pfmSuggestionGetPerformanceEvents関数のレスポンスのsuggestionに格納される値を指定します。 |
|
レスポンスのsuggestionメンバーに格納される値
処理が成功した場合，空文字が格納されます。
エラーケース
エラーが発生した場合，args.setError()関数を呼び出して，メッセージが格納されます。
エラー要因と格納されるメッセージのメッセージIDを，次の表に示します。
|
エラー要因 |
メッセージID |
|---|---|
|
提案定義ファイルのargsオブジェクトで，指定が必要なメンバーを指定していない。 |
KAJY24113-E |
|
提案定義ファイルのeventSidsに指定した値が誤っている。 |
|
|
JP1/IM2のAPIでエラーが発生した。 |
KAJY24116-E |
注意事項
-
この関数は，JP1/IM2のjp1EmService.changeEventStatusメソッドを使用しています。JP1/IM2の設定により，対処状況を更新できないことがあります。詳細については，JP1/IM2のマニュアルの，jp1EmService.changeEventStatusメソッドについて説明している個所を参照してください。
-
JP1/IM2のAPIでエラーが発生した場合，一部のJP1イベントの対象状況だけが「対処済」となる場合があります。その場合，メッセージに従って対処し，エラー要因を取り除いてから，再度この関数を実行してください。
提案定義ファイルでの指定例
この関数を使用した提案定義ファイルの記述例については，「提案定義ファイル（imdd_suggestion_任意の文字列.conf）の記述例」の「アラームまたはエージェントの状態が正常に回復したときに，イベントの対処状況を「対処済」に変更する場合の記述例」を参照してください。