jp1pfmSuggestionGetPerformanceEvents
機能
IM管理ノードにマッピングされているJP1イベントのうち，対処状況が「未対処」である重要イベントの一覧を取得する関数です。
取得対象のJP1イベントを次に示します。
-
Performance ManagementのすべてのJP1ユーザーイベント
-
イベントIDが「00004840」のJP1システムイベント
-
イベントIDが「00004850」のJP1システムイベントのうち，発行元がStoreサービスでないイベント
前提バージョン
-
PFM - ManagerおよびPFM - Web Console：12-00以降
-
JP1/IM2：12-50以降
提案定義ファイルでの指定方法
提案活性条件と対処アクションに指定する次のオブジェクトのメンバーに，必要な値を指定します。
-
提案活性条件のtypeが「plugin」のkeyオブジェクト
-
対処アクションのtypeが「plugin」のparamsオブジェクト
指定する値を，次の表に示します。
|
項番 |
メンバー名 |
データ型 |
省略可否 |
説明 |
|
|---|---|---|---|---|---|
|
1 |
sid |
string |
不可 |
Performance ManagementのIM管理ノードのツリーIDを指定します。 次のどれかに対応するIM管理ノードのツリーIDを指定できます。
ツリーIDの指定方法については，「提案定義ファイル（imdd_suggestion_任意の文字列.conf）の設定項目」を参照してください。 |
|
|
2 |
method |
string |
不可 |
"jp1pfmSuggestionGetPerformanceEvents"を指定します。 |
|
|
3 |
args |
object |
不可 |
項番4以降のメンバーを持つオブジェクトを指定します。 |
|
|
4 |
startTime |
string |
不可 |
イベントの登録日時の検索範囲（開始時刻）を「YYYY-MM-DDThh:mm:ssZ」形式※で指定します。 |
|
|
5 |
endTime |
string |
不可 |
イベントの登録日時の検索範囲（終了時刻）を「YYYY-MM-DDThh:mm:ssZ」形式※で指定します。 |
|
- 注※
-
ISO8601の拡張形式（秒の小数点以下は指定不可）でUTCの時刻を指定することを示します。各値の意味は次のとおりです。
-
YYYY：西暦年
-
MM：月
-
DD：日
-
T：日付と時刻の区切りです。
-
hh：時
-
mm：月
-
ss：秒
-
Z：UTCと同じであることを示します。
-
この関数を実行したあと，jp1pfmSuggestionGetCurrentlyNormalEvents関数とjp1pfmSuggestionSetStatusOfEventsToProcessed関数を呼び出して，正常回復したJP1イベントの対処状況を「対処済」に変更する場合，この関数のstartTimeとendTimeに指定した検索範囲のJP1イベントを，「対処済」に変更する対象とする。JP1イベントの対処状況を「対処済」に変更する提案の使用頻度に合わせて，startTimeとendTimeの値を指定してください。
レスポンスのsuggestionメンバーに格納される値
処理が成功した場合，IM管理ノードにマッピングされているJP1イベントのうち，検索範囲にあるイベントについて，次の表に示すオブジェクトの配列がJSON形式で格納されます。該当するJP1イベントが1つもない場合は，空文字が格納されます。
|
メンバー名 |
データ型 |
格納される値 |
|---|---|---|
|
eventSid |
string |
イベントのSIDが格納されます。 |
|
B.ID |
string |
イベントIDが格納されます。 |
|
B.TIME |
string |
イベントの登録日時が格納されます。 |
|
E.SEVERITY |
string |
イベントの重大度が格納されます。 |
|
E.PRODUCT_NAME |
string |
イベントのプロダクト名が格納されます。 |
|
E.OBJECT_NAME |
string |
|
|
E.ROOT_OBJECT_NAME |
string |
|
エラーケース
エラーが発生した場合，args.setError()関数を呼び出して，メッセージが格納されます。
エラー要因と格納されるメッセージのメッセージIDを，次の表に示します。
|
エラー要因 |
メッセージID |
|---|---|
|
提案定義ファイルのargsオブジェクトで，指定が必要なメンバーを指定していない。 |
KAJY24113-E |
|
提案定義ファイルのsidに，この関数で指定できない種類の，Performance ManagementのツリーSIDを指定した。 |
|
|
提案定義ファイルのstartTimeまたはendTimeに不正な値を指定した。 |
|
|
提案定義ファイルのendTimeに，startTimeよりも早い日時を指定した。 |
|
|
JP1/IM2のAPIでエラーが発生した。 |
KAJY24116-E |
注意事項
-
イベントの登録日時の検索範囲を長く指定した場合，処理に時間が掛かることがあります。
-
この関数は，JP1/IM2のjp1EmService.getEventメソッドを使用しています。JP1/IM2の設定により，JP1イベントを取得できないことがあります。詳細については，JP1/IM2のマニュアルの，jp1EmService.getEventメソッドについて説明している個所を参照してください。
提案定義ファイルでの指定例
この関数を使用した提案定義ファイルの記述例については，「提案定義ファイル（imdd_suggestion_任意の文字列.conf）の記述例」の「アラームまたはエージェントの状態が正常に回復したときに，イベントの対処状況を「対処済」に変更する場合の記述例」を参照してください。