5.8.3 IM管理ノードステータス取得
- 機能
-
IM管理ノード(管理グループまたは管理オブジェクト)のステータス情報をすべて取得します。IM管理ノードをパラメーターとして指定した場合は,指定したIM管理ノードのステータス情報だけを取得します。
ログインしたJP1ユーザーに参照権限が無いIM管理ノードを指定した場合,要素数0個の配列を返却します。
- 実行権限
-
-
JP1_Console_Admin
-
JP1_Console_Operator
-
JP1_Console_User
-
- APIのバージョン
-
v1
- 形式
-
- リクエスト行
POST /application/component/apiVersion/nodes/treeInfo/status httpVersion
- リクエストのメッセージボディー
{ "sid":[ "IM管理ノードのツリーのSID", … ] }
- レスポンスのメッセージボディー
{ "simtData":[ ステータス情報オブジェクト,… ] }
- パラメーター
-
- sid
-
IM管理ノードのツリーのSIDを指定します。指定したIM管理ノードのステータス情報を取得します。SIDについては「7.1 SID」を参照してください。
このパラメーターは複数指定することができます。
指定を省略した場合は,参照できるすべての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[]
取得したステータス情報をステータス情報オブジェクトの配列として返却します。
指定した識別IDに対応するIM管理ノードが存在しない場合や,参照できるIM管理ノードが無かった場合は,要素数0個の配列を返却します。
- 定義形式
{ simtData: [ { "sid": "ツリーのSID", "value":{ "status":{"JP1EVENT": ステータス値} } }, ・・・ ] }
- メンバー
-
メンバーを次に示します。
項番
メンバー名
データ型
説明
1
simtData
配列
ステータス情報を格納する配列
2
sid
string
IM管理ノードのツリーのSID
3
value
配列
ステータス値を格納する配列
4
status
string
IM管理ノードのSIDのステータス
ステータスのタイプ(JP1EVENT)とステータスを表す数値
返却対象となるsimtDataオブジェクトは,リクエストパラメーターで指定したツリーノードのうち,JP1イベント,または上位伝搬によって1度以上ステータスが変化したツリーノードのオブジェクトだけです。
また,ステータス値の意味を次に示します。
-
40:緊急・警戒・致命的以下の重要イベントが発生し,対処されていない状態。
-
30:エラー以下の重要イベントが発生し,対処されていない状態。
-
20:警告以下の重要イベントが発生し,対処されていない状態。
-
10:該当するすべての重要イベントを対処(または重要イベント解除・削除)し,システムが健全な状態。
-
- 使用例
-
管理オブジェクトであるジョブネット(sid:_JP1AJS-M_host1/_HOST_host1/_JP1SCHE_sche
dulerserv/_JP1JOBG_jobgroup/_JP1ROOTJOBNET_jobnet1)のステータスを取得するAPIの使用例を次に示します。
なお,Authorizationヘッダーの値は1行で指定する必要があります。
- リクエスト:
POST /im/api/v1/nodes/treeInfo/status HTTP/1.1 Authorization: Bearer xxxx Accept-Language: ja Content-Type: application/json Accept: application/json { "sid":[ "_JP1AJS-M_host1/_HOST_host1/_JP1SCHE_schedulerserv/_JP1JOBG_jobgroup/_JP1ROOTJOBNET_jobnet1" ] }
- レスポンス:
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_AllSystem", "value":{ "status":{"JP1EVENT": 40} } ] }