5.18.2　統合エージェント情報削除

機能

指定された統合エージェントの情報を削除するAPIです。指定された統合エージェントホストのPrometheusおよびFluentdがトレンドデータ管理DBに保存したトレンドデータを削除します。トレンドデータを削除したあと，トレンドデータ管理サービスを自動で再起動します。また，トレンドデータを削除した統合エージェントホストの情報を削除します。

ログインしたJP1ユーザーに参照・操作権限がある統合エージェントは削除できます。なお，トレンドデータの削除については，トレンドデータの削除対象に指定した統合エージェント，ユーザー独自のPrometheus，ユーザー独自のFluentdのホストのIM管理ノードに対して，参照・操作権限がある場合に，そのホストのPrometheusとFluentdが保存したトレンドデータをすべて削除します。

削除したあと，JP1/IM - Manager（インテリジェント統合管理基盤）のツリー情報には削除した情報は反映されません。反映する場合は，統合オペレーション・ビューアーからのツリー情報の生成および反映，またはjddcreatetreeコマンドおよびjddupdatetreeコマンド（構成変更モード（-cオプション）を指定）を実行してください。

実行権限

JP1_Console_Admin

APIのバージョン

形式

リクエスト行

POST /im/api/v1/agents/delete httpVersion

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

{
  "agents": [
    {
      "agenthost": 統合エージェントホスト名,
      "managerhost": マネージャーホスト名
    }, ・・・
  ]
}

レスポンスのメッセージボディー

正常終了の場合，レスポンスはありません。

警告終了の場合，次のレスポンスを返却します。

{
    "errhostlist":[
        {
            "agenthost": 統合エージェントホスト名,
            "managerhost": マネージャーホスト名
        },・・・
    ],
    "errdeletelist":[
        {
            "agenthost": 統合エージェントホスト名,
            "managerhost": マネージャーホスト名,
        },...
    ],
    "errrestartlist":[
        {
            "agenthost": 統合エージェントホスト名,
            "managerhost": マネージャーホスト名,
        },...
    ],
    "messageList":[
        {
            "messageId": メッセージID,
            "message": メッセージ
        }, ・・・
    ]
}

パラメーター

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

パラメーター名	データ型	省略可否	説明
`agents`	object[]	不可	削除する統合エージェントを指定します。指定できる統合エージェントは200件までです。空配列は指定できません。
`agenthost`	string	不可	統合エージェントのホスト名を1〜255バイトの範囲で指定します。
`managerhost`	string	不可	マネージャーホスト名を1〜255バイトの範囲で指定します。

パラメーター名

データ型

省略可否

説明

agents

object[]

不可

削除する統合エージェントを指定します。指定できる統合エージェントは200件までです。

空配列は指定できません。

agenthost

string

不可

統合エージェントのホスト名を1〜255バイトの範囲で指定します。

managerhost

string

不可

マネージャーホスト名を1〜255バイトの範囲で指定します。

レスポンス

パラメーター名		データ型	省略可否	説明
`errhostlist`		object[]	可	削除に失敗した統合エージェントの配列が設定されます。失敗したホストがない場合は省略されます。 `errdeletelist`のトレンドデータ削除に失敗したホストも含みます。
	`agenthost`	string	不可	統合エージェントのホスト名が設定されます。
	`managerhost`	string	不可	マネージャーホスト名が設定されます。
`errdeletelist`		object[]	可	トレンドデータを削除できなかった統合エージェントの配列が設定されます。失敗したホストがない場合は省略されます。
	`agenthost`	string	不可	トレンドデータを削除できなかった統合エージェントのホスト名が設定されます。
	`managerhost`	string	不可	トレンドデータを削除できなかったマネージャーホスト名が設定されます。
`errrestartlist`		object[]	可	トレンドデータの削除に成功して，トレンドデータ管理サービスの再起動に失敗した統合エージェントの配列が設定されます。再起動に失敗したホストがない場合は省略されます。
	`agenthost`	string	不可	トレンドデータの削除に成功して，トレンドデータ管理サービスの再起動に失敗した統合エージェントのホスト名が設定されます。
	`managerhost`	string	不可	トレンドデータの削除に成功して，トレンドデータ管理サービスの再起動に失敗したマネージャーホスト名が設定されます。
`messageList`		object[]	可	メッセージオブジェクトの配列が設定されます。メッセージが存在しない場合は省略されます。
	`messageId`	string	不可	メッセージIDが設定されます。
	`message`	string	不可	メッセージの本文が設定されます。使用される言語は，HTTPリクエストヘッダーのAccept-Languageプロパティの指定内容によって決まります。

ステータスコード

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

ステータスコード	メッセージ	説明
200	−	APIの処理が成功しました。
400	KAJY68201-E	APIのリクエストが不正です。リクエスト不正が一個所見つかった時点で処理を中断します。
200	KAJY68213-W	リクエストに指定した統合エージェントホスト名または，マネージャーホスト名がJP1/IM - Managerが管理する構成に存在しませんログインユーザーにリクエストに指定した統合エージェントの参照・操作権限がありませんリクエストに指定した統合エージェントまたはマネージャーホストの情報が統合エージェントホスト管理DBにありません。
403	KAJY01000-E	認証に使用したユーザーの権限が不足しています。
500	KAJY68501-E	指定された統合マネージャーの統合エージェントホスト管理DBに接続できません。
200	KAJY68500-W	指定された下位マネージャーの統合エージェントホスト管理DBに接続できません。
200	KAJY68204-W	指定された統合エージェントのマネージャーのインテリジェント統合管理基盤に接続できません。
200	KAJY68210-W	インテリジェント統合管理基盤の処理でエラーが発生しました。
200	KAJY62012-W	指定されたマネージャーホストのトレンドデータ管理DBにあるトレンドデータの削除に失敗した。
200	KAJY62013-W	指定されたマネージャーホストのトレンドデータ管理サービスの再起動に失敗した。
200	KAJY62014-W	トレンドデータ削除の処理で指定されたマネージャーホストの統合エージェント管理DBに接続できません。
200	KAJY62015-W	トレンドデータ削除または統合エージェント情報削除を連続で実行したため，トレンドデータの削除の処理が同一ホストのトレンドデータ管理DBに対して連続で実行されました。
200	KAJY62011-W	ログインユーザーにリクエストに指定した統合エージェント，ユーザー独自のPrometheus，ユーザー独自のFluentdのホストの参照・操作権限がありません。指定されたマネージャーホストが下位マネージャーで，［下位マネージャー一覧］画面で下位マネージャーに追加していません。指定されたエージェントホストが，統合マネージャーの管理する構成に存在しません。
200	KAJY68214-W	イベント転送中継元情報の削除に失敗しました。
500	KAJY00007-E	システムエラーが発生しました（ディスク不足，メモリー不足など）。

戻り値

なし

注意事項

マニュアル「JP1/Integrated Management 3 - Manager 導入設計ガイド」の「2.7.2(3)(h) トレンドデータの手動削除（管理対象から削除）」の「■トレンドデータの削除時の注意事項」を参照してください。

使用例

リクエスト：

POST http://hostname:20703/im/api/v1/agents/delete
{
    "agents": [
      {
        "agenthost":"hostA",
        "managerhost":"hostB"
      }
    ]
}

レスポンス：

< HTTP/1.1 200 OK
< Content-Type: application/json

ページの先頭へ

5.18.2 統合エージェント情報削除

5.18.2　統合エージェント情報削除