4.4.4　メソッド一覧

各製品の構成情報をJSON形式で返却するメソッドです。インテリジェント統合管理基盤では，アダプタコマンドを実行したあとアダプタコマンドの戻り値を確認し，戻り値が0のときだけこのメソッドを呼び出します。

• 構成情報の取得が正常に終了した場合

  __configurationGetメソッド内でargs.setResult（JSON形式の構成情報）メソッドを呼び出します。

• 構成情報の取得に失敗した場合

  args.setResultメソッドではなくargs.setError（エラーメッセージ）メソッドを呼び出します。

__configurationGetメソッド内では，自身が処理可能なコンポーネントの場合，args.setResultメソッドかargs.setErrorメソッドのどちらかのメソッドを必ず呼び出してください。

__configurationGetメソッドは，インテリジェント統合管理基盤のシステム管理ツリーを作成するjddcreatetreeコマンドの中で呼び出されます。

各ユーザー作成プラグインではargs.componentの値を参照し，自身が処理可能かどうかを判定してください。

__configurationGetメソッドのパラメーターを次に示します。

__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でセットした構成情報によって，影響を受ける機能と影響内容について，次の表に示します。

入力情報の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メソッドのパラメーターを次に示します。

__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管理ノードツリー情報によって，影響を受ける機能と影響内容について，次の表に示します。

各製品から発行されるすべてのJP1イベントに対応する構成情報のSIDを返却するメソッドです。各ユーザー作成プラグインでは，各製品が発行するすべてのJP1イベントに対して，構成情報のSIDを返却する必要があります。各ユーザー作成プラグインでは，args.productNameなどの値を参照し，自身が処理可能なイベントかどうかを判定します。

• 発行されたJP1イベントに対応する構成情報のSIDの生成が正常に終了した場合

  __eventGetメソッド内でargs.setTargetSid（構成情報のSID）メソッドを呼び出します。

• 発行されたJP1イベントの情報に不足があり，そのJP1イベントに対応する構成情報のSIDの生成に失敗した場合

  args.setError（エラーメッセージ）メソッドは呼び出さず，returnして処理を終了します。

__eventGetメソッドは，インテリジェント統合管理基盤がJP1イベントを取得したタイミングで呼び出されます。

__eventGetメソッドのパラメーターを次に示します。

setTargetSidをセットしたSID情報によって，影響を受ける機能と影響内容について，次の表に示します。

取得した構成間の関連を生成し，JSON形式で返却するメソッドです。

• 取得した構成間の関連の生成が正常に終了した場合

  __createLinkメソッド内でaddResult（JSON形式の取得した構成間の関連情報）メソッドを呼び出します。

• 構成情報の取得の失敗した場合

  addResultメソッドではなく，args.setError（エラーメッセージ）メソッドを呼び出します。

addResultメソッドまたはargs.setErrorメソッドのどちらかのメソッドを，必ず呼び出してください。

__createLinkメソッドは，インテリジェント統合管理基盤のシステム管理ツリーを作成するjddcreatetreeコマンドの中で呼び出されます。

__createLinkメソッドのパラメーターを次に示します。

__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でセットした関連情報によって，影響を受ける機能と影響内容について，次の表に示します。

与えられたJSON形式のリンク情報の配列について，valueパラメーターに動的な付与情報を追加して返却するメソッドです。

プラグインで処理できないリンク情報が含まれる場合，そのリンク情報はそのまま返却されます。

__linkValueGetメソッドのパラメーターを次に示します。

"value":{
    "unit": [
        {
           "precedingJob":"job1",
           "succeedingJob":"job2"
           "impact":true
        }
    ]
 }

__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)によって，影響を受ける機能と影響内容について，次の表に示します。

時系列データで表示可能なメトリックの一覧を取得し，JSON形式で返却するメソッドです。

__metricListGetメソッドのパラメーターを次に示します。

__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でセットしたメトリック一覧によって，影響を受ける機能と影響内容について，次の表に示します。

時系列データを取得し，JSON形式で返却するメソッドです。

取得した時系列データのデータ数とインスタンス数がcountPerInstance，instanceCount指定した上限を超える場合は，レスポンスのexceedCountDetectedオブジェクトの該当メンバーをtrueに設定し，データ数をcountPerInstance，instanceCountの範囲に収まるように選定して返却します。

__timeSeriesDataGetメソッドのパラメーターを次に示します。

__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でセットした時系列データによって，影響を受ける機能と影響内容について，次の表に示します。

指定したSIDに関連するモニター起動用のURLを取得し，JSON形式で返却するメソッドです。

__urlGetメソッドのパラメーターを次に示します。

__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情報によって，影響を受ける機能と影響内容について，次の表に示します。