5.8.4 構成管理ツリー情報取得
- 機能
-
インテリジェント統合管理基盤のステータス監視機能で表示するツリー形式の情報を取得します。ログインしたJP1ユーザーに参照権限が無いIM管理ノードツリー情報は取得できません。
- 実行権限
-
-
JP1_Console_Admin
-
JP1_Console_Operator
-
JP1_Console_User
-
- APIのバージョン
-
v1
- 形式
-
- リクエスト行
GET /application/component/apiVersion/nodes/treeInfo httpVersion
- リクエストのメッセージボディー
-
なし。
- レスポンスのメッセージボディー
{ "simtData":[ IM管理ノードツリー情報オブジェクト,… ] }
- パラメーター
-
なし。
- ステータスコード
-
リクエストに対するレスポンスとして返却されるステータスコードを,次の表に示します。
ステータスコード
メッセージ
説明
200
OK
IM管理ノードツリー情報の取得に成功しました。
400
Bad Request
リクエストヘッダーが不正です。
401
Unauthorized
認証が必要です。
403
Forbidden
実行権限がありません。
404
Not Found
リソースがありません。
406
Not Acceptable
Acceptヘッダー,Accept-Languageヘッダーの指定が不正です。
412
Precondition failed
サーバを利用できません。
415
Unsupported media type
Content-Typeヘッダーの指定が不正です。
500
Internal Server Error
サーバ処理エラーが発生しました。
- 戻り値
-
ステータスコードが200の場合に,レスポンスボディーに次の情報を返却します。
項番
メンバー名
データ型
説明
1
simtData
object[]
取得したIM管理ノードツリー情報をIM管理ノードツリー情報オブジェクトの配列として返却します。
参照できるIM管理ノードツリー情報が無かった場合は,要素数0個の配列を返却します。
IM管理ノードツリー情報オブジェクトについては「7.2.2(1) IM管理ノードツリーオブジェクト」を参照してください。
- 使用例
-
IM管理ノードツリー情報を取得するAPIの使用例を次に示します。
なお,Authorizationヘッダーの値は1行で指定する必要があります。
- リクエスト:
GET /im/api/v1/nodes/treeInfo HTTP/1.1 Authorization: Bearer xxxx Accept-Language: ja Content-Type: application/json Accept: application/json
- レスポンス:
HTTP/1.1 200 OK Cache-Control: no-store, no-cache, max-age=0 Pragma: no-cache Expires: Thu, 01 Jan 1970 00:00:00 GMT Content-Type: application/json { "simtData":[ {"sid":"_ROOT_AllSystems","value":{"target":[],"label":"All Systems"}}, {"sid":"_ROOT_AllSystems/_SYSTEM_System1","value":{"target":[],"label":"システム1",…}}, {"sid":"_ROOT_AllSystems/_SYSTEM_System1/_SYSTEM_SubSystem1","value":{"target":[],"label":"サブシステム1",…}}, {"sid":"_ROOT_AllSystems/_SYSTEM_System1/_SYSTEM_SubSystem1/_HOST_host1","value":{"target":[],"label":"host1",…}}, {"sid":"_ROOT_AllSystems/_SYSTEM_System1/_SYSTEM_SubSystem1/_HOST_host1/_CATEGORY_Job","value":{"target":[],"label":"Job",…}}, {"sid":"_ROOT_AllSystems/_SYSTEM_System1/_SYSTEM_SubSystem1/_HOST_host1/_CATEGORY_Job/_OBJECT_JP1AJSMJOB","value":{"target":[],"label":"JP1/AJS3 - Manager"}}, {"sid":"_ROOT_AllSystems/_SYSTEM_System1/_SYSTEM_SubSystem1/_HOST_host1/_CATEGORY_Job/_OBJECT_JP1AJSMJOB/_OBJECT_ScheduleServ","value":{"target":[],"label":"ScheduleServ"}}, {"sid":"_ROOT_AllSystems/_SYSTEM_System1/_SYSTEM_SubSystem1/_HOST_host1/_CATEGORY_Job/_OBJECT_JP1AJSMJOB/_OBJECT_ScheduleServ/_OBJECT_jobgroup","value":{"target":[],"label":"jobgroup",…}}, {"sid":"_ROOT_AllSystems/_SYSTEM_System1/_SYSTEM_SubSystem1/_HOST_host1/_CATEGORY_job/_OBJECT_JP1AJSMJOB/_OBJECT_ScheduleServ/_OBJECT_jobgroup/_OBJECT_jobnet1","value":{"target":[],"label":"jobnet1",…}} ] }