5.17.3　定義ファイル削除

機能

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

リクエストのヘッダー

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

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

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

[
  "filelist":[
    {
      "filename": "ファイル名",
      "filepath": "ファイルの絶対パス",
      "updateaction": "定義反映のための操作"
    }, ・・・
  ],
  "hostCategory":"ホスト種別",
  "managerHostName":"定義ファイル削除先Agentホスト管理先Mangerホスト名",
  "agentHostName":"定義ファイル削除先Agentホスト名"
]

パラメーター

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

パラメーター	省略可否	説明
filename	不可	ファイル名を指定します。
filepath	不可	ファイルの配置先を絶対パスで指定します。ファイルパスにファイル名を含めた絶対パスが，200文字を超えた場合は，エラーとなります。
updateaction	可	定義ファイルを更新した場合に実行すべき操作を，1〜4096バイトで指定します。
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の処理が成功しました。
200	KAJY68126-W	統合エージェント制御基盤でワーニングが発生しました。
400	KAJY68107-E	リクエストパラメーターが不正です。
400	KAJY68205-E	リクエストに指定した統合エージェントホスト名がJP1/IM - Managerが管理する構成に存在しません。ログインユーザーにリクエストに指定した統合エージェントの参照・操作権限がありません。リクエストに指定した統合エージェントまたはマネージャーホストの情報が統合エージェントホスト管理DBにありません。
403	KAJY01000-E	認証に使用したユーザーの権限が不足しています。
500	KAJY68104-E	統合エージェント制御基盤でエラーが発生しました。
	KAJY00007-E	システムエラーが発生しました（ディスク不足，メモリー不足など）。
	KAJY68203-E	インテリジェント統合管理基盤に接続できません。
	KAJY68212-E	統合エージェント制御基盤に接続できません。
	KAJY68501-E	マネージャーの統合エージェントホスト管理DBに接続できません。

レスポンス

ステータスコードが200の場合に，レスポンスボディーにJSON形式で次の情報を返却します。

{
  "filelist":[
    {
      "filename": "ファイル名",
      "filepath": "ファイルの絶対パス",
      "result": "ファイル削除の結果",
      "message": "メッセージ"
    }, ・・・
  ]
}

メンバー名	説明
filename	ファイル名を記載します。
filepath	ファイルの配置先の絶対パスを記載します。
result	ファイル削除の結果を記載します。記載する文字列については，表5-15を参照してください。
filelist:message	ファイル削除のための操作が失敗した場合のエラーメッセージIDとその本文を記載します。成功した場合は省略します。 resultが「recovery fail」の場合に記載するエラーメッセージは，定義反映のための操作に失敗したときのメッセージを記載します。

表5‒15　 resultの内容
ファイルの削除	定義反映のための操作	リカバリー処理	resultの内容
〇	〇	−	success
×	−	−	delete fail
〇	×	〇	action fail
〇	×	×	recovery fail

（凡例）: 〇：成功　×：失敗　−：処理なし

戻り値

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

なし

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

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

JP1/IM - Managerがバージョン13-10以降，かつ，定義ファイル削除先AgentホストのJP1/IM - Agentがバージョン13-10以降の場合で，すべての定義ファイルの削除に失敗したときは，「extensions」（拡張情報）に，次の情報を設定します。

項目	説明
`filelist`	このAPIの説明項目「レスポンス」のレスポンスボディーに示すJSON形式の文字列

使用例

リクエスト：

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

レスポンス：

HTTP/1.1 200 OK
Content-Type:application/json
・・・省略・・・
 
{
  "filelist":[
    {
      "filename": "user_file_sd_config_test.yml",
      "filepath": "C:\\Program Files\\Hitachi\\jp1ima\\conf\\user",
      "result": "delete fail",
      "message": "KAJY68126-W 統合エージェント制御基盤でワーニングが発生。(詳細情報: KNBC20015-W 定義ファイルの削除に失敗しました。(詳細情報: target file does not exist. filename=C:\\Program Files\\Hitachi\\jp1ima\\conf\\user\\user_file_sd_config_test.yml))"
    }, ・・・
  ]
}

注意事項

定義ファイルの削除後に，定義情報の反映のために，サービスが再起動されるおそれがあります。
定義ファイルの削除後のサービス起動に失敗した場合，リカバリー処理を行いますが，リカバリー処理にも失敗したときは，サービスが停止した状態になるおそれがあります。
クラスタ構成の場合，定義ファイルを削除したことによって，フェールオーバーが発生するおそれがあります。また，フェールオーバー先でもサービスを起動できず，フェールオーバーが失敗するおそれがあります。負荷の状況によっては，サービスの再起動やリカバリー処理に時間がかかり，クラスタ構成の場合は，クラスタソフトが異常と判断して，フェールオーバーが発生するおそれがあります。そのため，定義ファイルの削除は，システムのメンテナンスの時間に実施してください。

ページの先頭へ

5.17.3 定義ファイル削除

5.17.3　定義ファイル削除