5.8.1 IM管理ノード関連情報の生成
- 機能
-
JP1/AJS3,JP1/PFM,JP1/IM,およびJP1/Baseから各製品が管理する構成情報を取得し,次に示す定義ファイルを使用して,構成管理ツリーファイルを生成します。
-
システムノード定義ファイル(imdd_systemnode.conf)
-
IM管理ノードカテゴリ名称定義ファイル(imdd_category_name.conf)
-
構成取得対象ホスト定義ファイル(imdd_target_host.conf)
-
ホスト名定義ファイル(imdd_host_name.conf)
このAPIで作成したファイルの格納先ディレクトリは,次のとおりです。
- Windowsの場合
-
-
物理ホストのとき
Managerパス\tmp\imdd\imnode\data
-
論理ホストのとき
共有フォルダ\JP1IMM\tmp\imdd\imnode\data
-
- Linuxの場合
-
-
物理ホストのとき
/var/opt/jp1imm/tmp/imdd/imnode/data
-
論理ホストのとき
共有ディレクトリ/jp1imm/tmp/imdd/imnode/data
-
また,生成に成功した場合はJP1イベント「3F80」,生成に失敗した場合は「3F81」を発行します。
-
- 実行権限
-
次の権限が必要です。
-
JP1資源グループ:*
-
JP1権限レベル:JP1_Console_Admin
-
- APIのバージョン
-
v1
- 形式
-
- リクエスト行
POST /application/component/apiVersion/nodes/create httpVersion
- リクエストのメッセージボディー
なし
- レスポンスのメッセージボディー
-
正常終了の場合,レスポンスはありません。
警告終了の場合,次のレスポンスを返却します。
{ "returnCode": リターンコード, "messageList":[ { "messageId": メッセージID, "message": メッセージ }, ・・・ ] }
- パラメーター
-
なし
- ステータスコード
-
リクエストに対するレスポンスとして返却されるステータスコードを,次の表に示します。
ステータスコード
メッセージ
説明
200
OK
成功しました。
400
Bad Request
リクエストヘッダーが不正です。
403
Forbidden
実行権限がありません。
404
Not Found
リソースがありません。
406
Not Acceptable
Acceptヘッダー,Accept-Languageヘッダーの指定が不正です。
408
Request Timeout
リクエストがタイムアウトしました。
415
Unsupported media type
Content-Typeヘッダーの指定が不正です。
500
Internal Server Error
サーバ処理エラーが発生しました。
503
Service Unavailable
サービスが利用できません。
サービスが一時的に過負荷やメンテナンスで使用不可となっています。
一時的なエラーが発生した場合(時間経過で改善する見込みがある場合)に返却します。
- 戻り値
-
戻り値
説明
2
排他中です。
6
本APIの実行に必要な情報が不足しています。
9
格納ディレクトリのパスが長すぎます。
13
前提ファイルが存在しません。
14
前提ファイルの読み込みに失敗しました。
15
前提ファイルのフォーマット不正です。
16
前提ファイルの記載内容不正です。
17
プラグインからの情報取得に失敗しました。
18
プラグインからの情報が不正です。
20
IM管理ノードファイルの作成に失敗しました。
21
IM管理ノードリンクファイルの作成に失敗しました。
23
IM管理ノードツリーファイルの作成に失敗しました。
26
認証に使用したユーザーの権限が不足しています。
255
システムエラーです。
- 使用例
-
構成管理ツリーファイルを生成するAPIの使用例を次に示します。
- リクエスト:
POST /im/api/v1/nodes/create HTTP/1.1 Authorization: Bearer anAxYWRtaW46TUdGa01tTTJNMlV3TURFNFh6STNYekE0T2pJME9qTXpYMTlmWDE5ZlgxOWZYMTlmWDE5ZlgycHdNV0ZrYldsdUlDQWdJQ0FnSUNBZ0lDQWdJQ0FnSUNBZ0lDQWdJQ0Fn 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