4.4.4 メソッド一覧
ユーザー作成プラグインで実装するメソッド一覧を次に示します。
なお,すべてのメソッドを実装する必要はありません。各製品で実装が必要なものだけを選択して実装してください。各製品のプラグインメソッドについては,各製品のマニュアルを参照してください。
項番 |
カテゴリ |
メソッド名 |
説明 |
4.1の番号※2 |
---|---|---|---|---|
1 |
構成情報取得 |
構成情報を取得するメソッドです。 |
1 |
|
2 |
ツリー情報を取得するメソッドです。 |
|||
3 |
イベント |
JP1イベントを処理するメソッドです。 |
5 |
|
4 |
関連情報取得 |
取得した構成間の関連を生成する処理を行うメソッドです。 |
2 |
|
5 |
リンク情報の詳細情報を取得するメソッドです。 |
|||
6 |
トレンド情報取得 |
取得可能な時系列データのメトリックの一覧を取得するメソッドです。 |
3 |
|
7 |
時系列データを取得するメソッドです。 |
|||
8 |
url情報取得 |
モニター起動用のURLを取得するメソッドです。 |
6 |
|
9 |
ユーザー作成の任意のメソッド※1 |
ユーザー作成の任意のメソッド※1 |
ユーザーが作成する任意のメソッドです。 「_」アンダースコアから始まるメソッド名は付けないでください。 |
3 |
- 〈この項の構成〉
(1) __configurationGetメソッド
- 機能
-
各製品の構成情報をJSON形式で返却するメソッドです。インテリジェント統合管理基盤では,アダプタコマンドを実行したあとアダプタコマンドの戻り値を確認し,戻り値が0のときだけこのメソッドを呼び出します。
-
構成情報の取得が正常に終了した場合
__configurationGetメソッド内でargs.setResult(JSON形式の構成情報)メソッドを呼び出します。
-
構成情報の取得に失敗した場合
args.setResultメソッドではなくargs.setError(エラーメッセージ)メソッドを呼び出します。
__configurationGetメソッド内では,自身が処理可能なコンポーネントの場合,args.setResultメソッドかargs.setErrorメソッドのどちらかのメソッドを必ず呼び出してください。
__configurationGetメソッドは,インテリジェント統合管理基盤のシステム管理ツリーを作成するjddcreatetreeコマンドの中で呼び出されます。
各ユーザー作成プラグインではargs.componentの値を参照し,自身が処理可能かどうかを判定してください。
-
- パラメーター
-
__configurationGetメソッドのパラメーターを次に示します。
表4‒7 __configurationGetメソッドのパラメーター 項番
メンバー
説明
備考
1
hostname
構成情報の取得元ホスト名
なし
2
component
構成情報の管理元コンポーネント名
3
data
アダプタコマンドの実行結果
ヘッダー情報に記載されている文字コードに基づき,UTF-8形式に変換された文字列です。
ヘッダー情報は含まれません。
4
jp1UserName
JP1ユーザー名
各製品の管理者権限を持つユーザー
5
jp1Token
jp1UserNameのJP1トークン
JP1トークンはBASE64エンコード済み
6
protocolName
プロトコル名称
アダプタコマンドの実行結果に含まれていたヘッダー情報
7
protocolVersion
プロトコルバージョン
アダプタコマンドの実行結果に含まれていたヘッダー情報
8
codeset
文字コード
アダプタコマンドの実行結果に含まれていたヘッダー情報
9
productName
製品名称
アダプタコマンドの実行結果に含まれていたヘッダー情報
10
setResult(String json)
JSON形式の構成情報をセットするメソッド
なし
11
setError(String message)
エラー通知用のメソッド
エラーメッセージをセットします。
12
stderr
アダプタコマンドが標準エラー出力に出力した値を格納する
- 返却する構成情報一覧
-
__configurationGetメソッドが返却する構成情報の一覧について説明します。
- 取得形式
{ "meta":{ "timestamp":"作成時刻(ISO8601形式 UTC時刻)", "objectRoot":[ { "type":"オブジェクトルートノード種別", "defaultSystem": { "name":"デフォルトシステムノードの構造化IDの名称", "label":"デフォルトシステムノードの表示名" } },… ] }, "simtData":[ {"sid":"<SID>","value":{付与情報}}, … ] }
- 記述内容
-
取得したインフラ一覧の記述内容を次に示します。
表4‒8 取得したインフラ一覧の記述内容 項番
項目名
データ型
説明
1
meta
Object
ファイルの情報を格納するオブジェクト
2
timestamp
string
ファイル作成の年月日,日時をISO8601形式のUTC時刻で返却する
この属性は省略できません。
時間はJP1/IM - Managerのサーバ時間です。
3
objectRoot
配列
オブジェクトルートノード種別とデフォルトのシステムノード情報を格納する配列
この属性は省略できます。
4
type
string
ツリーのルートノードおよびシステムノード配下に配置するオブジェクトルートノード種別(ネットワーク機器(NETWORKDEVICE)やストレージ(STORAGE)など)を表す
ホスト(HOST)の指定は不要です。必ずツリーのルートノードおよびシステムノード配下に配置してください。
この属性は省略できます。省略した場合は,ホストだけをツリーのルートノードおよびシステムノード配下に配置します。
5
defaultSystem
Object
オブジェクトルートノードが親ノードとなるデフォルトのシステムノードを作成する場合に指定する
この属性を省略した場合,typeで指定したオブジェクトルートノードのデフォルトのツリーノードは,AllSystems直下に配置されます。
6
name
string
デフォルトのシステムノードの構成情報のSIDの名称を指定する
この属性を省略した場合,オブジェクトルートノード種別を構成情報のSIDの名称とします。
7
label
string
デフォルトのシステムノードのlabelを指定する
この属性を省略した場合,デフォルトのシステムノードの付与情報にlabel属性は設定されません。
8
simtData
配列
構成情報の配列
9
sid
string
構成情報のSIDを表す
10
value
Object
付与情報を表す
- 取得例
-
__configurationGetメソッドが各製品から取得する情報については,「7.1.4 各製品から取得する情報」を参照してください。
- setResultでセットした構成情報による影響
-
setResultでセットした構成情報によって,影響を受ける機能と影響内容について,次の表に示します。
表4‒9 影響する機能一覧 項番
機能名
影響内容
1
システムのステータス監視
-
IM管理ノードの取得機能が,セットした構成情報をIM管理ノードファイルとして出力します。
-
IM管理ノードツリー生成機能※が構成情報を元にツリーを生成し,IM管理ノードツリーファイルとして出力します。
-
__eventGetメソッドが構成情報のSIDを使用します。__eventGetによって,JP1イベントとIM管理ノードをマッピングします。
2
IM管理ノードによるシステムの統合監視
__createLink,またはIM管理ノードリンク定義ファイル(imdd_nodeLink_def.conf)で,構成情報のSIDを使用します。
typeがrootJobnetExecutionOrder(ルートジョブネット実行順序)のIM管理ノードリンクに従い,業務フローを表示します。
3
カスタムUI表示
構成情報のSIDに従い,カスタムUIの画面を表示します。
4
関連ノード表示
__createLink,またはIM管理ノードリンク定義ファイル(imdd_nodeLink_def.conf)で,構成情報のSIDを使用します。IM管理ノードリンクに従い,関連ノードを表示します。
5
IM管理ノードのプロパティ表示
構成情報の付与情報(value)のpropertyに設定した情報を表示します。
6
連携製品画面の起動
構成情報の付与情報(value)のmethodsに__urlGetが設定されているIM管理ノードについて,連携製品元の画面を起動します。
7
トレンド情報表示
構成情報の付与情報(value)のmethodsに__metricListGetおよび__timeSeriesDataGetが設定されているIM管理ノードについて,指定したメトリックのトレンド情報を表示します。
-
(2) __createTreeNodeメソッド
- 機能
-
入力情報のsimtDataに対応するツリーのSIDおよび付与情報を取得し,JSON形式で返却するメソッドです。
ユーザー作成プラグインに__createTreeNodeメソッドを実装すると,JP1/IMのデフォルトツリーをカスタマイズできます。デフォルトツリーの詳細については「7.4.2 ノード生成機能」を参照してください。
ユーザー作成プラグインは,simtDataのツリーのSIDがカスタマイズ対象ツリーノードのターゲットの場合にツリーノードオブジェクトを生成し,それをsetResultします。ターゲットのオブジェクトタイプと名前がどちらも同じsimtDataの場合は,ツリー上で同一ノードにします。このため,オブジェクトタイプと名前がどちらも同じsimtDataは,同じツリーのSIDを返却するように設定してください。
カスタマイズ対象のツリーノードの親ノードをカスタマイズしない場合は,treeNodeCreatorオブジェクトを使用して親ノード部分のツリーのSID取得し,ツリーのSIDの一部として使用してください。
-
ツリーのSIDおよび付与情報の取得が正常に終了した場合
__createTreeNodeメソッド内でargs.setResult(JSON形式のツリーのSID)メソッドを呼び出します。
-
ツリーのSIDおよび付与情報の取得に失敗した場合
args.setResultメソッドではなくargs.setError(エラーメッセージ)メソッドを呼び出します。
__createTreeNodeメソッド内では,自身が処理可能なSimtDataの場合,args.setResultメソッドかargs.setErrorメソッドのどちらかのメソッドを必ず呼び出してください。
__createTreeNodeメソッドは,インテリジェント統合管理基盤のシステム管理ツリーを作成するjddcreatetreeコマンドの中で呼び出されます。
-
- パラメーター
-
__createTreeNodeメソッドのパラメーターを次に示します。
表4‒10 __createTreeNodeメソッドのパラメーター 項番
メンバー
説明
備考
1
jp1UserName
JP1ユーザー名
なし
2
jp1Token
jp1UserNameに対応するJP1認証トークン
3
simtData
ツリーのSIDを取得したいSimtData
4
treeNodeCreator
作成済みのノード情報の管理およびデフォルトのツリー作成機能を提供するオブジェクト
詳細は「4.4.4(2)(a) treeNodeCreatorオブジェクト」を参照してください。
5
setResult (String json)
JSON形式の取得したツリーのSIDおよび付与情報をセットするメソッド
6
setError (String message)
エラー通知用のメソッド
エラーメッセージをセットします。
- 返却するツリーのSIDおよび付与情報の形式
-
__createTreeNodeメソッドが返却するツリーのSIDおよび付与情報の形式について説明します。
- 取得形式
{ "meta":{ "componentName":"ツリー情報の取得対象コンポーネント名" }, "simtData":[ {"sid":"ツリーのSID","value":{付与情報}}, ・・・ ] }
- 記述内容
-
取得したツリーのSIDおよび付与情報の記述内容を次に示します。
表4‒11 取得したツリーのSIDおよび付与情報の記述内容 項番
項目名
データ型
説明
1
meta
Object
メタ情報を表す
2
componentName
string
ツリー情報の取得対象コンポーネント名を表す
3
simtData
Object
simtDataを表す
4
sid
string
ツリーのSIDを表す
5
value
Object
付与情報を表す
- 取得例
-
__createTreeNodeメソッドの取得例を次に示します。
{ "meta":{ "componentName":"/HITACbHI/JP1/OA/CONFINFO" }, "simtData":[ { "sid":"_ROOT_AllSystems/_HOST_host1/_CATEGORY_job /_SUBCATEGORY_JP1%2FAJS3%20-%20Manager/_OBJECT_AJSROOT1", "value": { "target":["_JP1AJS-M_host1/_HOST_host1/_JP1SCHE_AJSROOT1"], "label":"AJSROOT1"}} } } ] }
- setResultでセットしたIM管理ノードツリー情報による影響
-
setResultでセットしたIM管理ノードツリー情報によって,影響を受ける機能と影響内容について,次の表に示します。
表4‒12 影響する機能一覧 項番
機能名
影響内容
1
システムのステータス監視
IM管理ノードツリー生成機能※が生成したツリー情報に,IM管理ノードツリー情報をマージして,IM管理ノードツリーファイルとして出力します。
(a) treeNodeCreatorオブジェクト
treeNodeCreatorオブジェクトは,getObjectRootTreeSIDメソッド,getHostNameDefメソッドおよびgetCategoryNameメソッドを提供します。
(b) getObjectRootTreeSIDメソッド
getObjectRootTreeSIDメソッドは,パラメーターで指定したtarget(SID)に対応するツリーのSIDを返却するメソッドです。オブジェクトノードの親ノードをカスタマイズしない場合に使用し,オブジェクトノードのツリーのSIDの一部として使用します。
- パラメーター
-
getObjectRootTreeSIDメソッドのパラメーターを次に示します。
表4‒13 getObjectRootTreeSIDメソッドのパラメーター 項番
項目名
データ型
説明
1
target
string
カスタマイズするツリーノードの親ノードに当たるオブジェクトルートノードの構成情報のSID
2
objectRoot
Object[]
オブジェクトルートノードの情報
次の形式で指定します。
[{"type":"オブジェクトルートノード種別"},,,},※…]
- 戻り値
-
targetに対応したツリーのSIDを返却します。戻り値は,getObjectRootTreeSIDメソッドを呼び出すタイミングのツリーノードの生成状況に応じて異なります。
表4‒14 getObjectRootTreeSIDメソッドの戻り値 項番
生成状況
戻り値
1
ツリーノードが生成済みの場合
targetに対応した生成済みのツリーのSIDを返却する
2
ツリーノードが生成されていない場合
targetの内容を解析して,システムノード定義ファイル(imdd_systemnode.conf),ホスト名定義ファイル(imdd_host_name.conf)の定義内容に基づいたツリーのSIDを生成する
システムノード定義ファイル(imdd_systemnode.conf)の定義内容に一致しない場合は,デフォルトのツリーのSIDを返却します。
システムノード定義ファイル(imdd_systemnode.conf)の詳細については,「システムノード定義ファイル(imdd_systemnode.conf)」(2. 定義ファイル)を参照してください。
(c) getHostNameDefメソッド
getHostNameDefメソッドは,ホスト名定義ファイル(imdd_host_name.conf)に従って,パラメーターで指定したhostNameに対応するホスト名定義を返却するメソッドです。HOSTノードのツリーをカスタマイズする場合はこのメソッドを使用し,HOSTノードのツリーのSIDの名称とラベルとして使用します。
- パラメーター
-
getHostNameDefメソッドのパラメーターを次に示します。
表4‒15 getHostNameDefメソッドのパラメーター 項番
項目名
データ型
説明
1
hostName
string
ホスト名(エイリアス名)を指定する
- 戻り値
-
getHostNameDefメソッドは,ホスト名定義ファイル(imdd_host_name.conf)の定義内容に従って,次の値を返却します。
{"hostName":"定義ファイルの値","label":"定義ファイルの値"}
対応するホスト名定義が無い場合は,nullを返却します。
ホスト名定義ファイル(imdd_host_name.conf)については,「ホスト名定義ファイル(imdd_host_name.conf)」(2. 定義ファイル)を参照してください。
(d) getCategoryNameメソッド
getCategoryNameメソッドは,パラメーターで指定したcategory(ID)に対応するカテゴリ名を返却するメソッドです。カスタマイズするツリーにCATEGORYノードを含む場合はこのメソッドを使用し,ツリーのSIDのラベルとして使用します。
- パラメーター
-
getCategoryNameメソッドのパラメーターを次に示します。
表4‒16 getCategoryNameメソッドのパラメーター 項番
項目名
データ型
説明
1
category
string
categoryのID
- 戻り値
-
getCategoryNameメソッドは,IM管理ノードカテゴリ名称定義ファイル(imdd_category_name.conf)の定義内容に従って,categoryに対応するカテゴリ名を返却します。
対応するカテゴリ名の定義が無い場合は,nullを返却します。
IM管理ノードカテゴリ名称定義ファイル(imdd_category_name.conf)については,「IM管理ノードカテゴリ名称定義ファイル(imdd_category_name.conf)」(2. 定義ファイル)を参照してください。
(3) __eventGetメソッド
- 機能
-
各製品から発行されるすべてのJP1イベントに対応する構成情報のSIDを返却するメソッドです。各ユーザー作成プラグインでは,各製品が発行するすべてのJP1イベントに対して,構成情報のSIDを返却する必要があります。各ユーザー作成プラグインでは,args.productNameなどの値を参照し,自身が処理可能なイベントかどうかを判定します。
-
発行されたJP1イベントに対応する構成情報のSIDの生成が正常に終了した場合
__eventGetメソッド内でargs.setTargetSid(構成情報のSID)メソッドを呼び出します。
-
発行されたJP1イベントの情報に不足があり,そのJP1イベントに対応する構成情報のSIDの生成に失敗した場合
args.setError(エラーメッセージ)メソッドは呼び出さず,returnして処理を終了します。
__eventGetメソッドは,インテリジェント統合管理基盤がJP1イベントを取得したタイミングで呼び出されます。
-
- パラメーター
-
__eventGetメソッドのパラメーターを次に示します。
表4‒17 __eventGetメソッドのパラメーター 項番
メンバー
説明
備考
1
productName
プロダクト名
なし
2
idBase
イベントID
10進数の数値
3
event
JP1イベントの情報
event.sid:JP1イベントのSID
event.value:JP1イベントのvalue値※
4
setTargetSid(String sid)
JP1イベントに対応する構成情報のSIDをセットするメソッド
なし
5
setError(String message)
エラー通知用のメソッド
エラー通知をセットします。
- setTargetSidをセットしたSID情報による影響
-
setTargetSidをセットしたSID情報によって,影響を受ける機能と影響内容について,次の表に示します。
表4‒18 影響を受ける機能一覧 項番
機能名
影響内容
1
システムのステータス監視
構成情報のSIDがtargetとなっているIM管理ノードとJP1イベントをマッピングします。
jddupdatetreeコマンドを構成変更モードで実行した場合,このメソッドで返却した構成情報のSIDのホスト名情報が,構成から削除された構成情報のSIDのJP1イベントの再マッピング先のホストを決定するために使用されます。
(4) __createLinkメソッド
- 機能
-
取得した構成間の関連を生成し,JSON形式で返却するメソッドです。
-
取得した構成間の関連の生成が正常に終了した場合
__createLinkメソッド内でaddResult(JSON形式の取得した構成間の関連情報)メソッドを呼び出します。
-
構成情報の取得の失敗した場合
addResultメソッドではなく,args.setError(エラーメッセージ)メソッドを呼び出します。
addResultメソッドまたはargs.setErrorメソッドのどちらかのメソッドを,必ず呼び出してください。
__createLinkメソッドは,インテリジェント統合管理基盤のシステム管理ツリーを作成するjddcreatetreeコマンドの中で呼び出されます。
-
- パラメーター
-
__createLinkメソッドのパラメーターを次に示します。
表4‒19 __createLinkメソッドのパラメーター 項番
メンバー
説明
備考
1
jp1UserName
JP1ユーザー名
なし
2
jp1Token
jp1UserNameに対応するJP1認証トークン
3
simtFileList
構成情報の全リストデータ
IM管理ノードオブジェクトが複数あるデータ構造
4
addResult(String json)
JSON形式の取得した構成間の関連情報をセットするメソッド
なし
5
setError(String message)
エラー通知用のメソッド
エラーコードとメッセージをセットします。
- 返却する関連情報の形式
-
__createLinkメソッドが返却する取得した構成間の関連情報の形式について説明します。
- 取得形式
-
setResultに設定する構成情報の形式を次に示します。
{ "meta":{ "format":"ファイル種別", "componentName":"関連情報の取得対象コンポーネント名", "timestamp":"関連情報生成時刻" }, "links":[ { "from":"先行ノードのSID", "to":"後続ノードのSID", "type":"処理対象種別", "value":付与情報 }, ... ], }
- 記述内容
-
取得した構成間の関連情報の記述内容を次に示します。
表4‒20 取得した構成間の関連情報の記述内容 項番
項目名
データ型
説明
1
meta
配列
ファイルの情報を格納する配列
2
format
string
ファイルの種別
固定値として「conf」を指定します。
この属性は省略できません。
3
componentName
string
関連情報の取得対象コンポーネント名
この属性は省略できません。
4
timestamp
string
ファイル作成の年月日,日時をISO8601形式のUTC時刻で返却する
この属性は省略できません。
時間は関連情報を生成したJP1/IM - Managerのサーバ時間です。
5
links
配列
構成間の関連情報の配列
配列順序に意味はありません。
from,to,typeが同じ関連情報が複数存在した場合は,jddcreatetreeコマンドでそれぞれ出力されますが,jddupdatetreeコマンドでシステムに反映する際は,最後に出現した関連情報が反映されます。
ただし,JP1/AJSのプラグインからの構成情報(componentNameが「/HITACHI/JP1/AJS3/CONFINFO」)の場合で,typeがrootJobnetExecutionOrder(ルートジョブネット実行順序)でfrom,toが同じときは,基盤がvalue.unit配列に格納されているオブジェクトをマージして単一のlinkオブジェクトとしてIM管理ノードリンクファイルに出力します。
6
from
string
先行ノード
先行ノードのSIDを指定します。
- 指定例
-
_ToolA-M_hostA/_HOST_hostA
to属性が指定されている場合,この属性を省略できます。制御文字は指定できません。
7
to
string
後続ノード
後続ノードのSIDを指定します。
- 指定例
-
_ToolA-M_hostA/_ToolA-A_hostB/_HOST_hostB
from属性が指定されている場合,この属性を省略できます。制御文字は指定できません。
8
type
string
関連情報の種別を指定する。
「_」アンダースコアから始まる文字列,制御文字は指定できません。255バイト以内の半角英数字で指定します。
typeは同じ意味を持つ関連同士をグループ化する情報です。[統合オペレーション・ビューアー]画面の[関連ノード]タブでは,typeごとに関連をフィルタリングして表示することができます。
JP1/IMの製品内や他製品との連携では次の種別を使用します。
-
rootJobnetExecutionOrder:ルートジョブネット実行順序の関連
-
rootJobnetAgent:ルートジョブネットとAJSエージェントの関連
-
managerAgent:JP1製品のマネージャーとエージェントの関連
-
sameNode:名称が同一のノードの関連
-
L2Connection:JP1/NNMiで管理するレイヤー2接続線の関連
-
Infrastructure:JP1/OAで管理するインフラリソースの関連
-
monitoringConfiguration:監視製品の構成における製品と監視対象の関連
これらの種別以外に,ユーザーが任意の種別を指定することもできます。
9
value
Object
構成間の関連情報の付与情報を指定する。
種別がrootJobnetAgentの場合に,標準でサポートされているパラメーターを以下に示します。
-
precedingJob:連携ジョブの先行ジョブを完全名で指定する
-
succeedingJob:連携ジョブの後続ジョブを完全名で指定する
この属性は省略できます。
- 取得例
-
__createLinkメソッドの取得例を次に示します。
{ "meta":{ "format":"conf" "componentName":"/HITACHI/JP1/AJS3/CONFINFO" "timestamp":"2018-11-11T00:00:00Z" }, "links":[ { "from":"JP1AJS-M_AJSM1/_HOST_AJShost1/_JP1SCHE_S1/_JP1JOBG_JG1/_JP1ROOTJOBNET_root1", "to":"JP1AJS-M_AJSM2/_HOST_AJShost2/_JP1SCHE_S2/_JP1JOBG_JG2/_JP1ROOTJOBNET_root2", "type":"rootJobnetExecutionOrder", "value": { "precedingJob":"root1/job1", "succeedingJob":"root2/job2", } }, ... ], }
- addResultでセットした関連情報による影響
-
addResultでセットした関連情報によって,影響を受ける機能と影響内容について,次の表に示します。
表4‒21 影響する機能一覧 項番
機能名
影響内容
1
システムのステータス監視
IM管理ノードの取得機能が,IM管理ノードリンクオブジェクトをIM管理ノードリンクファイルとして出力します。
2
IM管理ノードによるシステムの統合監視
typeがrootJobnetExecutionOrder(ルートジョブネット実行順序)のIM管理ノードリンクに従って,[業務フロー]タブに関連を表示します。
3
関連ノード表示
IM管理ノードリンクに従って,[関連ノード]タブに関連を表示します。
4
連携ユニット表示
typeがrootJobnetExecutionOrder(ルートジョブネット実行順序)のIM管理ノードリンクについて,その付与情報(value)のunitに設定されたユニット情報(__linkValueGetの結果を含む)を表示します。
5
後続ルートジョブネットへの影響表示
typeがrootJobnetExecutionOrder(ルートジョブネット実行順序)のIM管理ノードリンクについて,その付与情報(value)のunitに設定されたユニット(最新世代)が,後続ユニットに及ぼす影響(__linkValueGetの結果)を表示します。
(5) __linkValueGetメソッド
- 機能
-
与えられたJSON形式のリンク情報の配列について,valueパラメーターに動的な付与情報を追加して返却するメソッドです。
プラグインで処理できないリンク情報が含まれる場合,そのリンク情報はそのまま返却されます。
- パラメーター
-
__linkValueGetメソッドのパラメーターを次に示します。
表4‒22 __linkValueGetメソッドのパラメーター 項番
メンバー
説明
備考
1
jp1UserName
JP1ユーザー名
なし
2
jp1Token
jp1UserNameに対応するJP1認証トークン
3
linksData
リンク情報オブジェクトの配列のオブジェクト
4
links
リンク情報オブジェクトの配列
省略されません。空の配列は指定されません。
5
from
先行ノードのSID
なし
6
to
後続ノードのSID
7
type
処理対象種別
8
value
付与情報
9
select
取得するvalueのパラメーターの配列
オブジェクトやオブジェクトの配列のメンバーをさらに指定したい場合は,<オブジェクト名>.<メンバー名>と指定します。
以下の例で"impact"だけを指定したい場合はselectに"unit.impact"と指定します。
"value":{ "unit": [ { "precedingJob":"job1", "succeedingJob":"job2" "impact":true } ] }
省略できます。
省略した場合はすべてのパラメーターを取得します。
10
setResult(String json)
JSON形式のリンク情報をセットするメソッド
なし
11
setError(String message)
エラー通知用のメソッド
エラーコードとメッセージをセットします。
- 返却するリンク情報の形式
-
__linkValueGetメソッドが返却するリンク情報の形式について説明します。
- 取得形式
{ "links": [ { "from":"先行ノードのSID", "to":"後続ノードのSID", "type":"処理対象種別", "value":付与情報 }, ・・・ ] }
- 記述内容
-
取得したリンク情報の記述内容を次に示します。
表4‒23 取得したリンク情報の記述内容 項番
項目名
データ型
説明
1
links
配列
リンク情報の配列
2
from
string
先行ノードのSID
3
to
string
後続ノードのSID
4
type
string
処理対象種別
5
value
Object
構成間の関連情報の付与情報を指定する
- 取得例
-
__linkValueGetメソッドの取得例を次に示します。
{ "links": [ { "from":"_JP1AJS-M_HOST1/_HOST_HOST1/_JP1SCHE_schedulerserv/ _JP1JOBG_jobgroup/_JP1ROOTJOBNET_jobnet1", "to":"_JP1AJS-M_HOST1/_HOST_HOST1/_JP1SCHE_schedulerserv/ _JP1JOBG_jobgroup/_JP1ROOTJOBNET_jobnet2", "type":"rootJobnetExecutionOrder", "value":{ "unit": [ { "precedingJob":"job1", "succeedingJob":"job2" "succeedingJobStartTime":"2019−05−14T00:00:00Z", "precedingJobURL":"http://10.220.196.82:22252/ajs/・, "succeedingJobURL":"http://10.220.196.82:22252/ajs/・, "impact":"error" } ・・・ ], "msg":"KAJY04254-E The collecting information process could not be generated." } }, ・・・ ] }
- setResultでセットしたリンクの付与情報(value)による影響
-
setResultでセットしたリンクの付与情報(value)によって,影響を受ける機能と影響内容について,次の表に示します。
表4‒24 影響する機能一覧 項番
機能名
影響内容
1
連携ユニット表示
typeがrootJobnetExecutionOrder(ルートジョブネット実行順序)のIM管理ノードリンクについて,その付与情報(value)のunitに設定された情報を表示します。
また,URLパラメーターは,そのURLを指定したWWWブラウザーを起動します。
2
後続ルートジョブネットへの影響表示
typeがrootJobnetExecutionOrder(ルートジョブネット実行順序)のIM管理ノードリンクについて,その付与情報(value)のunitに設定されたユニット(最新世代)が,後続ユニットに及ぼす影響を表示します。
(6) __metricListGetメソッド
- 機能
-
時系列データで表示可能なメトリックの一覧を取得し,JSON形式で返却するメソッドです。
- パラメーター
-
__metricListGetメソッドのパラメーターを次に示します。
表4‒25 __metricListGetメソッドのパラメーター 項番
メンバー
説明
備考
1
jp1UserName
JP1ユーザー名
なし
2
jp1Token
jp1UserNameに対応するJP1認証トークン
3
sid
メトリクス一覧を取得したい構成情報のsid
4
lang
取得するメトリック一覧の言語
5
setResult(String json)
JSON形式の取得したメトリック一覧をセットするメソッド
6
setError(String message)
エラー通知用のメソッド
エラーコードとメッセージをセットします。
- 返却するメトリック一覧の形式
-
__metricListGetメソッドが返却するメトリック一覧を次に示します。
- 取得形式
{ "metrics":[ { "name":"メトリック", "label":"メトリック表示名", "category":"メトリックのカテゴリ", "description":"メトリックの説明", "default":デフォルト設定 } ・ ]
- 記述内容
-
取得したメトリック一覧の記述内容を次に示します。
表4‒26 取得したメトリック一覧の記述内容 項番
項目名
データ型
説明
1
metrics
配列
メトリック情報の配列
指定できる要素数は100です。空の配列は指定できません。この項目は省略できません。
2
name
string
メトリック名
半角英数字と以下の記号で指定できます。
-(ハイフン),_(アンダーバー)
1〜255文字以内で指定します。
空文字は指定できません。この項目は省略できません。
3
label
string
メトリック表示名
1〜255文字の制御文字以外の文字で指定します。空文字は指定できません。この項目は省略できます。
4
category
string
メトリックのカテゴリ
1〜255文字の制御文字以外の文字で指定します。空文字は指定できません。この項目は省略できます。
5
description
string
メトリックの説明
1〜1,023文字の制御文字以外の文字で指定します。空文字は指定できません。この項目は省略できます。
JP1/IM - Manager(インテリジェント統合管理基盤)の[オペレーション・ビューアー]画面を使用する場合,長い文字列を指定すると,[トレンド]タブのメトリック表示名のツールチップで表示する文字列が.WWWブラウザーの制限(title属性で表示可能な文字数)によって途中で打ち切られる場合があります。
6
default
boolean
デフォルトのメトリックかどうかを指定する
-
true:デフォルトのメトリック
-
false:デフォルトのメトリックでない
デフォルトに指定できるメトリックの数は10までです。この項目は省略できません。
-
- 取得例
-
__metricListGetメソッドの取得例を次に示します。
{ "metrics":[ { "name":"CPU Usage", "label":"CPU使用率", "category":"CPU", "description":"CPUの使用率をコアごとに表示。(単位%)", "default":true } ・ ] }
- setResultでセットしたメトリック一覧による影響
-
setResultでセットしたメトリック一覧によって,影響を受ける機能と影響内容について,次の表に示します。
表4‒27 影響する機能一覧 項番
機能名
影響内容
1
トレンド情報表示
[トレンド]タブの[トレンドグラフ設定]領域に,グラフ表示するメトリックの選択候補として一覧表示します。
(7) __timeSeriesDataGetメソッド
- 機能
-
時系列データを取得し,JSON形式で返却するメソッドです。
取得した時系列データのデータ数とインスタンス数がcountPerInstance,instanceCount指定した上限を超える場合は,レスポンスのexceedCountDetectedオブジェクトの該当メンバーをtrueに設定し,データ数をcountPerInstance,instanceCountの範囲に収まるように選定して返却します。
- パラメーター
-
__timeSeriesDataGetメソッドのパラメーターを次に示します。
表4‒28 __timeSeriesDataGetメソッドのパラメーター 項番
メンバー
説明
備考
1
jp1UserName
JP1ユーザー名
なし
2
jp1Token
jp1UserNameに対応するJP1認証トークン
3
sid
時系列データを取得したい構成情報のsid
4
lang
取得する時系列データの言語
5
metric
メトリック名
1〜255文字以内で指定します。
空の配列は指定できません。この項目は省略できません。
6
startTime
時系列データの開始日時をISO 8601形式のUTC時刻で指定する。小数点以下の秒数は指定しない。
7
endTime
時系列データの終了日時をISO 8601形式のUTC時刻で指定する。小数点以下の秒数は指定しない。
8
countPerInstance
取得する1インスタンスあたりのデータ数の上限
countPerInstanceの値とinstanceCountの値を掛けた値が30,000以下であることを保証する。
9
instanceCount
インスタンス数の上限
10
setResult(String json)
JSON形式の時系列データをセットするメソッド
なし
11
setError(String message)
エラー通知用のメソッド
エラーメッセージをセットします。
- 返却する時系列データの形式
-
__timeSeriesDataGetメソッドが返却する時系列データを次に示します。
- 取得形式
{ "metric":"メトリック", "timeSeriesData":[ { "instance":"インスタンス名" "unit":"単位", "data":[ {"time":"時刻","value":値}, ・・・ ] }, ・・・ ], "exceedCountDetected": { countPerInstance:1インスタンスごとのデータ数上限超過検知有無, instanceCount: インスタンス数の上限超過検知有無 } }
- 記述内容
-
取得した時系列データの記述内容を次に示します。
表4‒29 取得した時系列データの記述内容 項番
項目名
データ型
説明
1
timeSeriesData
配列
時系列データの配列
空の配列は指定できません。この項目は省略できません。
2
metric
string
メトリック名
半角英数字と以下の記号で指定できます。
-(ハイフン),_(アンダーバー)
1〜255文字以内で指定します。
空文字は指定できません。この項目は省略できません。
3
instance
string
インスタンス名
1〜255文字の制御文字以外の文字で指定します。空文字は指定できません。この項目は省略できます。
4
unit
string
メトリックの単位
1〜255文字の制御文字以外の文字で指定します。空文字は指定できません。この項目は省略できません。
5
data
配列
時刻,値の二次元データの配列
指定された期間に時系列データが存在しない場合は,空の配列を指定します。
この項目は省略できません。
6
time
string
データの時刻
ISO 8601形式のUTC時刻です。小数点以下の秒数は指定できません。
-
dataが空の場合:省略できます。
-
dataが空以外の場合:省略できません。空文字の指定はできません。
7
value
number
データの値
javascriptのnumberの精度に合わせます。
-
dataが空の場合:省略できます。
-
dataが空以外の場合:省略できません。
8
exceedCountDetected
Object
上限検知オブジェクト
この項目は省略できません。
9
countPerInstance
boolean
1インスタンスあたりのデータ数が上限を超えたことの検知有無
-
上限を超えた場合:true
-
それ以外の場合:false
この項目は省略できません。
10
instanceCount
boolean
インスタンス数が上限を超えたことの検知有無
-
上限を超えた場合:true
-
それ以外の場合:false
この項目は省略できません。
-
- 取得例
-
__timeSeriesDataGetメソッドの取得例を次に示します。
{ "metric":"CPU Usage", "timeSeriesData":[ { "instance":"CPU_1" "unit":"%", "data":[ {"time":"2019-05-22T00:00:00Z","value":14.04}, ・・・ ] }, { "instance":"CPU_2" "unit":"%", "data":[ {"time":"2019-05-22T00:00:00Z","value":09.24}, ・・・ ] }, ・・・ ], "exceedCountDetected": { "countPerInstance":true, "instanceCount":false } }
指定したメトリック,期間でデータが存在しない場合
{ "metric":"CPU Usage", "timeSeriesData":[ { "unit":"%", "data":[ ] } ], "exceedCountDetected": { "countPerInstance": false, "instanceCount": false } }
- setResultでセットした時系列データによる影響
-
setResultでセットした時系列データによって,影響を受ける機能と影響内容について,次の表に示します。
表4‒30 影響する機能一覧 項番
機能名
影響内容
1
トレンド情報表示
時系列データをトレンド表示します。
(8) __urlGetメソッド
- 機能
-
指定したSIDに関連するモニター起動用のURLを取得し,JSON形式で返却するメソッドです。
- パラメーター
-
__urlGetメソッドのパラメーターを次に示します。
表4‒31 __urlGetメソッドのパラメーター 項番
メンバー
説明
備考
1
jp1UserName
JP1ユーザー名
なし
2
jp1Token
jp1UserNameに対応するJP1認証トークン
3
sid
関連するモニター起動用のURLを取得したい構成情報のSID
4
setResult(String json)
JSON形式のURL情報をセットするメソッド
5
setError(String message)
エラー通知用のメソッド
エラーメッセージをセットします。
- 返却するモニター起動用URLの形式
-
__urlGetメソッドが返却するモニター起動用のURLを次に示します。
- 取得形式
{ urlList:[ { "url":"モニター起動用URL", "name":"URLの名称" }, … ] }
- 記述内容
-
取得したモニター起動用のURLの記述内容を次の表に示します。
表4‒32 取得したモニター起動用のURL情報の記述内容 項番
項目名
データ型
説明
1
urlList
配列
URL情報オブジェクトの配列
2
url
string
URLの文字列
3
name
string
URLの名称
- 取得例
-
__urlGetメソッドの取得例を次に示します。
{ urlList:[ { "url":"http://10.220.196.82:22252/ajs/login.html?manager=10.220.196.82&type=monitor・, "name":"rootJobNet1のモニター起動画面" } ] }
- setResultでセットしたURL情報による影響
-
setResultでセットしたモニター起動用のURL情報によって,影響を受ける機能と影響内容について,次の表に示します。
表4‒33 影響する機能一覧 項番
機能名
影響内容
1
連携製品画面起動
構成情報の付与情報(value)のmethodsに,__urlGetが設定されているIM管理ノードについて,連携製品元の画面を起動します。