5.17.2　定義ファイル取得

機能

JP1/IM - ManagerまたはJP1/IM - Agentの定義ファイルを取得します。

実行権限

次の権限が必要です。

hostCategoryに「Manager」を指定する場合

JP1資源グループ：*
JP1権限レベル：JP1_Console_Admin

hostCategoryに「Agent」を指定する場合

JP1権限レベル：JP1_Console_Admin

APIのバージョン

形式

リクエスト行

POST /application/component/apiVersion/fileOperation/getFile httpVersion

リクエストのヘッダー

「5.2.3　リクエスト形式」のリクエストヘッダーに従います。

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

リクエストのメッセージボディーは，JSONフォーマットで送信できます。

[
  "filelist":[
    {
      "filename": "ファイル名",
      "filepath": "ファイルの絶対パス"
    }, ・・・
  ],
  "hostCategory":"ホスト種別",
  "managerHostName":"定義ファイル取得先Agentホスト管理先Mangerホスト名",
  "agentHostName":"定義ファイル取得先Agentホスト名"
]

パラメーター

リクエストのメッセージボディーに指定するパラメーターを次に示します。

パラメーター	省略可否	説明
filename	不可	ファイル名を指定します。
filepath	不可	ファイルの配置先を絶対パスで指定します。ファイルパスにファイル名を含めた絶対パスが，200文字を超えた場合は，エラーとなります。
hostCategory	不可	ホスト種別として「Manager」または「Agent」を指定します。指定したホスト種別の定義ファイルに対して操作を行います。
managerHostName	「説明」欄を参照	hostCategoryが「Manager」の場合指定項目を無視します。自ホストをJP1/IMのマネージャーホストと仮定し，JP1/IMのマネージャーホストの定義ファイルを取得します。 hostCategoryが「Agent」の場合定義ファイル取得先のエージェントを管理しているJP1/IMのマネージャーホスト名を1〜255バイトで指定します。
agentHostName	「説明」欄を参照	hostCategoryが「Manager」の場合指定項目を無視します。 hostCategoryが「Agent」の場合定義ファイル取得先のエージェントホスト名を1〜255バイトで指定します。

ステータスコード

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

ステータスコード	メッセージ	説明
200	−	APIの処理が成功しました。
400	KAJY68105-E	リクエストパラメーターが不正です。
400	KAJY68205-E	リクエストに指定した統合エージェントホスト名がJP1/IM - Managerが管理する構成に存在しませんログインユーザーにリクエストに指定した統合エージェントの参照・操作権限がありませんリクエストに指定した統合エージェントまたはマネージャーホストの情報が統合エージェントホスト管理DBにありません
403	KAJY01000-E	認証に使用したユーザーの権限が不足しています。
500	KAJY68104-E	統合エージェント制御基盤でエラーが発生しました。
	KAJY00007-E	システムエラーが発生しました（ディスク不足，メモリー不足など）。
	KAJY68203-E	インテリジェント統合管理基盤に接続できません。
	KAJY68212-E	統合エージェント制御基盤に接続できません。
	KAJY68501-E	マネージャーの統合エージェントホスト管理DBに接続できません。

取得したい定義ファイルが存在せず，圧縮した定義ファイルが作成できる場合（複数のファイルを取得しようとして，一部のファイルが存在しなかった場合），取得に失敗したファイルの情報は，定義ファイルを圧縮したzipファイルの中にある定義ファイルプロパティファイルに記載します。

レスポンス

ステータスコードが200の場合に，レスポンスボディーにzip形式に圧縮した定義ファイルのファイルデータを返却します。

レスポンスヘッダーとして，次の情報を設定します。

Content-Type:application/zip
Content-Disposition: attachment; filename="zip形式に圧縮した定義ファイルのファイル名"

ほかのレスポンスヘッダーは，APIの共通仕様と同じです。APIの共通仕様のレスポンスヘッダーについては，「5.2.5(2)　レスポンスヘッダー」を参照してください。

戻り値

ステータスコードが200の場合

レスポンスのメッセージボディーに，zip形式に圧縮した定義ファイルのファイルデータが返却されます。
ステータスコードが200以外の場合

レスポンスのメッセージボディーに，「5.2.6 エラー発生時のレスポンスメッセージ」に記載されているレスポンス形式の例外オブジェクトが返却されます。

使用例

リクエスト：

POST http://hostname:20703/im/api/v1/fileOperation/getFile  HTTP/1.1
Authorization:Bearer anAxYWRtaW46TUdGa01tTTJNMlV3TURFNFh6STNYekE0T2pJME9qTXpYMTlmWDE5ZlgxOWZYMTlmWDE5ZlgycHdNV0ZrYldsdUlDQWdJQ0FnSUNBZ0lDQWdJQ0FnSUNBZ0lDQWdJQ0Fn
Accept-Language: ja
Content-Type: application/json
Content-Length: 1024000
Accept: application/zip
{
  "filelist":[
    {
      "filename": "jpc_imagent.json",
      "filepath": "C:\\Program Files\\Hitachi\\jp1ima\\conf",
    }, ・・・
  ],
  "hostCategory":"Agent",
  "managerHostName":"immanager",
  "agentHostName":"imagent"
}

レスポンス：

HTTP/1.1 200 OK
Content-Type:application/zip
Content-Disposition: attachment; filename="C:\Program Files\Hitachi\jp1ima\tmp\upload\imagenthost_UUID.zip"
・・・省略・・・

ページの先頭へ

5.17.2 定義ファイル取得

5.17.2　定義ファイル取得