5.8.3 IM管理ノード情報取得
- 機能
-
JP1/AJS3やJP1/PFM,JP1/IM,JP1/Baseなどから取得したIM管理ノード情報を取得します。ログインしたJP1ユーザーの参照権限に関わらず,すべてのIM管理ノード情報を取得できます。
- 実行権限
-
-
JP1_Console_Admin
-
JP1_Console_Operator
-
JP1_Console_User
-
- APIのバージョン
-
v1
- 形式
-
- リクエスト行
GET /application/component/apiVersion/nodes/configInfo 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管理ノード情報を取得するAPIの使用例を次に示します。
なお,Authorizationヘッダーの値は1行で指定する必要があります。
- リクエスト:
GET /im/api/v1/nodes/configInfo 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":"_JP1AJS-M_host1/_HOST_host1","value":{…}}, {"sid":"_JP1AJS-M_host1/_HOST_host1/_JP1SCHE_schedulerserv","value":{…}}, {"sid":"_JP1AJS-M_host1/_HOST_host1/_JP1SCHE_schedulerserv/_JP1JOBG_jobgroup","value":{…}}, {"sid":"_JP1AJS-M_host1/_HOST_host1/_JP1SCHE_schedulerserv/_JP1JOBG_jobgroup/_JP1ROOTJOBNET_jobnet1","value":{…}}, {"sid":"_JP1AJS-M_host1/_JP1AJS-A_AGT10/_HOST_host10","value":{…}}, {"sid":"_JP1PFM-M_host2/_HOST_host2","value":{…}}, {"sid":"_JP1PFM-M_host2/_JP1PFM-A_servid/_HOST_host20","value":{…}} ] }