5.17.1　定義ファイル一覧取得

機能

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/getFileList httpVersion

リクエストのヘッダー

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

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

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

[
  "hostCategory":"ホスト種別",
  "managerHostName":"定義ファイル一覧取得先Agentホスト管理先Mangerホスト名",
  "agentHostName":"定義ファイル一覧取得先Agentホスト名"
]

パラメーター

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

パラメーター	省略可否	説明
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の処理が成功しました。
	KAJY02058-W	ユーザー作成定義ファイルリスト定義ファイルのフォーマット不正です。
	KAJY68102-W	ユーザー作成定義ファイルリスト定義ファイルに記載のファイルが存在しません。製品提供の定義ファイルが存在しません。
	KAJY68103-W	ファイル名またはファイルパスの長さが上限を超えています。
		必須の設定がありません。
		カテゴリ名が不正です（文字列の長さが上限を超えています，または，「jp1_」から始まっています）。
		定義反映のための操作の文字列の長さが上限を超えています。
		ユーザー作成定義ファイルリスト定義ファイルに定義できないファイルが指定されています。
	KAJY68126-W	統合エージェント制御基盤でワーニングが発生しました。
400	KAJY68101-E	リクエストパラメーターが不正です。
400	KAJY68205-E	リクエストに指定した統合エージェントホスト名がJP1/IM - Managerが管理する構成に存在しませんログインユーザーにリクエストに指定した統合エージェントの参照・操作権限がありませんリクエストに指定した統合エージェントまたはマネージャーホストの情報が統合エージェントホスト管理DBにありません
403	KAJY01000-E	認証に使用したユーザーの権限が不足しています。
500	KAJY68104-E	統合エージェント制御基盤でエラーが発生しました。
	KAJY00007-E	システムエラーが発生しました（ディスク不足，メモリー不足など）。
	KAJY68203-E	インテリジェント統合管理基盤に接続できません。
	KAJY68212-E	統合エージェント制御基盤に接続できません。
	KAJY68501-E	マネージャーの統合エージェントホスト管理DBに接続できません。

戻り値

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

レスポンスのメッセージボディーに，「7.2.4(1)　自動対処アクション定義オブジェクト」に記載されている自動対処アクション定義オブジェクトが返却されます。

データの形式については，マニュアル「JP1/Integrated Management 3 - Manager 導入・設計ガイド」の「3.6.5(1) 定義ファイルの一覧取得機能」を参照してください。JP1/IM - Agentと仕様が異なる部分を次に示します。

メンバー名	説明
errfilelist:message	エラーメッセージのメッセージIDとメッセージ本文を記載します。成功した場合は省略します。 KAJY68102-W，KAJY68103-Wのメッセージを設定します。
message:errmessage	エラーメッセージのメッセージIDとメッセージ本文を記載します。成功した場合はmessageの項目を省略します。KAJY02058-Wのメッセージを設定します。

メンバー名

説明

errfilelist:message

エラーメッセージのメッセージIDとメッセージ本文を記載します。成功した場合は省略します。

KAJY68102-W，KAJY68103-Wのメッセージを設定します。

message:errmessage

エラーメッセージのメッセージIDとメッセージ本文を記載します。成功した場合はmessageの項目を省略します。KAJY02058-Wのメッセージを設定します。

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

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

使用例

リクエスト：

POST http://hostname:20703/im/api/v1/fileOperation/getFileList  HTTP/1.1
Authorization:Bearer anAxYWRtaW46TUdGa01tTTJNMlV3TURFNFh6STNYekE0T2pJME9qTXpYMTlmWDE5ZlgxOWZYMTlmWDE5ZlgycHdNV0ZrYldsdUlDQWdJQ0FnSUNBZ0lDQWdJQ0FnSUNBZ0lDQWdJQ0Fn
Accept-Language: ja
Content-Type: application/json
Content-Length: 1024000
Accept: application/json
{
  "hostCategory":"Agent",
  "managerHostName":"immanager",
  "agentHostName":"imagent"
}

レスポンス：

HTTP/1.1 200 OK
Content-Type:application/json
・・・省略・・・
 
{
  "filelist":[
    {
      "filename": "jpc_alertmanager.yml",
      "filepath": "C:\\Program Files\\Hitachi\\jp1ima\\conf",
      "filecategoryID": "jp1_imagent",
      "filecategoryName": "jp1_imagent",
      "updatetime": "2023-07-21T10:23+09:00",
      "updateaction": "jp1ima\\addon_management\\alertmanager\\addon_jpc_service_reload.bat"
    }, ・・・
  ],
"errfilelist":[
    {
      "filename": "file_sd_config_test.yml",
      "filepath": "C:\\Program Files\\Hitachi\\jp1ima\\conf",
    }, ・・・
  ]
}

ページの先頭へ

5.17.1 定義ファイル一覧取得

5.17.1　定義ファイル一覧取得