jp1pfmSuggestionCreateReportURL
機能
指定したレポートIDのレポートを表示するURLを生成する関数です。
前提バージョン
-
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 |
不可 |
"jp1pfmSuggestionCreateReportURL"を指定します。 |
|
3 |
args |
object |
不可 |
項番4のメンバーを持つオブジェクトを指定します。 |
|
4 |
reportId |
string |
不可 |
表示するレポートのレポートID※を指定します。
|
レスポンスのsuggestionメンバーに格納される値
処理が成功した場合,指定したレポートIDのレポートを表示するURLの文字列が格納されます。
エラーケース
エラーが発生した場合,args.setError()関数を呼び出して,メッセージが格納されます。
エラー要因と格納されるメッセージのメッセージIDを,次の表に示します。
エラー要因 |
メッセージID |
---|---|
処理中にJP1/IM2の構成情報が変更された。 |
KAJY24105-E |
提案定義ファイルのargsオブジェクトで,指定が必要なメンバーを指定していない。 |
KAJY24113-E |
提案定義ファイルのsidに,この関数で指定できない種類の,Performance ManagementのツリーSIDを指定した。 |
注意事項
指定したレポートIDのレポートが,PFM - Managerに定義されているかのチェックは行われません。
提案定義ファイルでの指定例
この関数を使用した提案定義ファイルの記述例については,「提案定義ファイル(imdd_suggestion_任意の文字列.conf)の記述例」の「CPU使用率が高騰したときに,原因のプロセスを特定するレポートを表示する場合の記述例」を参照してください。