5.5.1　リンク情報取得

機能

ジョブなどのオブジェクトの順序関係を表す，リンク情報を取得します。

システムにリンク情報が登録されている場合に，特定のオブジェクトの前後などの指定された条件を満たすリンク情報を取得します。

実行権限

マニュアル「JP1/Integrated Management 2 - Manager 導入・設計ガイド」の「インテリジェント統合管理基盤によるシステムの運用監視で必要な操作権限」について記載している節を参照してください。

APIのバージョン

形式

リクエスト行

POST /application/component/apiVersion/links httpVersion

リクエストのメッセージボディー

{
    "type": 処理対象種別,
    "sid": 処理対象IM管理ノードのSID,
    "fromLayerCount": 先行ノード階層数,
    "toLayerCount": 後続ノード階層数,
    "countPerLayer": 1階層当たりのノード数,
    "linkCount": ノード関係数
}

レスポンスのメッセージボディー

{
    "links": [
        {
            "from": 先行ノードのSID,
            "to": 後続ノードのSID,
            "type": 処理対象種別
        }, ...
    ],
    "exceedCountDetected": {
        "countPerLayer": {
        ...,
            "layer-2": -2階層の階層あたりノード数オーバー検知有無,
            "layer-1": -1階層の階層あたりノード数オーバー検知有無,
            "layer0": 0階層の階層あたりノード数オーバー検知有無,
            "layer1": 1階層の階層あたりノード数オーバー検知有無,
            "layer2": 2階層の階層あたりノード数オーバー検知有無,
            ...
         },
        "linkCount": ノード関係数オーバー検知有無
    },
    "messageId": メッセージID,
    "message":メッセージ
}

パラメーター

type

システムに適用されているリンク情報の種別のうち，取得したいリンク情報の種別を指定します。

typeは同じ意味を持つ関連同士をグループ化する情報です。統合オペレーション・ビューアーの［関連ノード］タブでは，typeごとに関連をフィルタリングして表示することができます。

JP1/IMの製品内や他製品との連携では次の種別を使用します。これらの種別以外に，ユーザーが任意の種別を指定することもできます。

rootJobnetExecutionOrder：ルートジョブネット実行順序の関連
managerAgent：JP1製品のマネージャーとエージェントの関連
rootJobnetAgent：ルートジョブネットとAJSエージェントの関連
sameNode：名称が同一のノードの関連
L2Connection：JP1/NNMiで管理するレイヤー2接続線の関連
Infrastructure：JP1/OAで管理するインフラリソースの関連
monitoringConfiguration：監視製品の構成における製品と監視対象の関連

この属性を省略，またはこの属性に空文字列を指定した場合，リンク情報の種別に関わらず，該当するリンク情報を返却します。

この属性を指定した場合，該当するリンク情報のうち，指定した種別のリンク情報を返却します。

sid

処理対象とするノードのSIDを指定します。指定した部位の先行・後続ノード情報が返却されます。

（例）ルートジョブネットを指定する場合

_JP1AJS-M_JP1/AJS3マネージャーホスト名/_HOST_JP1/AJS3マネージャーホスト名/_JP1SCHE_スケジューラーサービス名/_JP1JOBG_ジョブグループ名/_JP1ROOTJOBNET_ノード名

このパラメーターの指定を省略した場合は，すべてのリンク情報を取得します。

fromLayerCount

取得する先行ノード階層数の上限値を，0〜2147483647の範囲で指定します。

sidを指定した場合，fromLayerCountパラメーターは省略できません。

sidを省略した場合，fromLayerCountパラメーターの指定は無視されます。

リンク情報の中に同一ノードが複数階層に存在すると，階層の捉え方によっては指定値を超える場合があります。

このような現象が問題となる場合は，この現象が発生するリンク情報かどうかを確認してから使用してください。

toLayerCount

取得する後続ノード階層数の上限値を，0〜2147483647の範囲で指定します。

sidを指定した場合，toLayerCountパラメーターは省略できません。

sidを省略した場合，toLayerCountパラメーターの指定は無視されます。

リンク情報の中に同一ノードが複数階層に存在すると，階層の捉え方によっては指定値を超える場合があります。

このような現象が問題となる場合は，この現象が発生するリンク情報かどうかを確認してから使用してください。

countPerLayer

取得するノード数のノード階層当たりの上限値を，1〜2147483647の範囲で指定します。

sidを指定した場合，countPerLayerパラメーターは省略できません。

sidを省略した場合，countPerLayerパラメーターの指定は無視されます。

リンク情報の中に同一ノードが複数階層に存在すると，階層の捉え方によっては指定値を超える場合があります。

このような現象が問題となる場合は，この現象が発生するリンク情報かどうかを確認してから使用してください。

linkCount

取得するノードノード関係数（先行ノードと後続ノードのペアの数）の上限値を，1〜2147483647の範囲で指定します。

sidを指定した場合，linkCountパラメーターは省略できません。

sidを省略した場合，linkCountパラメーターの指定は無視されます。

リンク情報の中に同一ノードが複数階層に存在すると，階層の捉え方によっては指定値を超える場合があります。

このような現象が問題となる場合は，この現象が発生するリンク情報かどうかを確認してから使用してください。

ステータスコード

リクエストに対するレスポンスとして返却されるステータスコードを，次の表に示します。

ステータスコード	メッセージ	説明
200	なし	上限の制約のため，返却されないデータは存在しない。
200	KAJY22000-W	上限の制約のため，返却されないデータが存在する。
400	KAJY22002-E	リクエストのパラメーター指定形式が不正です。（キーが無い，仕様とデータ型が異なる）
500	KAJY22002-E	リクエストのパラメーター指定形式が不正です。（値が不正）

メッセージの詳細については，マニュアル「JP1/Integrated Management 2 - Manager メッセージ」を参照してください。

戻り値

ステータスコードが200の場合に，レスポンスボディーに次の情報を返却します。

項番	メンバー名	データ型	説明
1	`links`	配列	レスポンスオブジェクトの配列配列順序に意味はありません。
2	`from`	string	先行ノード形式はメッセージボディーのsidと同じです。
3	`to`	string	後続ノード形式はメッセージボディーのsidと同じです。
4	`type`	string	リクエストパラメーターのtypeと同じ値
5	`exceedCountDetected`	オブジェクト	パラメーター指定値が上限を超えたことの検知有無パラメーターごとにメンバーを持ちます。sidを省略した場合は省略されます。
6	`countPerLayer`	boolean	階層当たりのノード数が上限を超えたことの検知有無階層ごとにメンバーを持ちます。
7	`layer`整数	string	返却対象となる全階層に対し，階層あたりのノード数が上限を超えたことの検知有無 sidに指定された階層を階層0として，後続の階層は順に+1，先行の階層は順に-1の規則で階層に番号を付けて，整数の部分に埋め込みます。
8	`linkCount`	boolean	リンク数が上限を超えたことの検知有無 true：検知した false：検知していない
9	`messageId`	string	メッセージID 通知すべきメッセージが存在しない場合は省略されます。
10	`message`	string	メッセージ本文使用される言語は，HTTPリクエストヘッダーの`Accept-Language`プロパティの指定内容により決まります。通知すべきメッセージが存在しない場合は省略されます。

使用例1

次の条件で実行した場合の使用例を説明します。

出力対象システム識別子

JP1/AJS3マネージャーホスト名：host1

スケジューラーサービス名：scheduler1

ジョブグループ名：jobgroup1

ノード名：rootjobnet3
取得する先行ノード階層数：100
取得する後続ノード階層数：1
ノード階層あたり取得ノード数：100
取得するノード関係数：100
ノード関連図
メッセージ言語：英語

リクエスト：

POST /im/api/v1/links 1.1
Authorization: Bearer XXXX
Accept-Language: ja
Content-Type: application/json
Accept: application/json
{
    "type": "rootJobnetExecutionOrder",
    "sid": "_JP1AJS-M_host1/_HOST_host1/_JP1SCHE_scheduler1/_JP1JOBG_jobgroup1/_JP1ROOTJOBNET_rootjobnet3",
    "fromLayerCount": 100,
    "toLayerCount": 1,
    "countPerLayer": 100,
    "linkCount": 100
}

レスポンス：

HTTP/1.1 200 OK
Content-Type: application/json
{
    "links": [
        {
        "from": "_JP1AJS-M_host1/_HOST_host1/_JP1SCHE_scheduler2/_JP1JOBG_jobgroup3._JP1ROOTJOBNET_rootjobnet1",
        "to": "_JP1AJS-M_host1/_HOST_host1/_JP1SCHE_scheduler1/_JP1JOBG_jobgroup1/_JP1ROOTJOBNET_rootjobnet3",
"type": "rootJobnetExecutionOrder"
        },
        {
        "from": "_JP1AJS-M_host1/_HOST_host1/_JP1SCHE_scheduler4/_JP1JOBG_jobgroup3/_JP1ROOTJOBNET_rootjobnet2",
        "to": "_JP1AJS-M_host1/_HOST_host1/_JP1SCHE_scheduler1/_JP1JOBG_jobgroup1/_JP1ROOTJOBNET_rootjobnet3",
        "type": "rootJobnetExecutionOrder"
        },
        {
        "from": "_JP1AJS-M_host1/_HOST_host1/_JP1SCHE_scheduler1/_JP1JOBG_jobgroup1/_JP1ROOTJOBNET_rootjobnet3",
        "to": "_JP1AJS-M_host1/_HOST_host1/_JP1SCHE_scheduler1/_JP1JOBG_jobgroup2/_JP1ROOTJOBNET_rootjobnet4",
        "type": "rootJobnetExecutionOrder"
        }
        ],
        "exceedCountDetected": {
            "countPerLayer": {
                "layer-1": false,
                "layer0": false,
                "layer1": false,
                 },
        "linkCount": false
    },
    "messageId": "KAJY22000-W",
    "message": "There is data that is not displayed because the upper limit is reached. (item = succeeding node layer count)"
}

ページの先頭へ

5.5.1 リンク情報取得

5.5.1　リンク情報取得