5.18.2 統合エージェント情報削除
- 機能
-
指定された統合エージェントの情報を削除するAPIです。
ログインしたJP1ユーザーに参照・操作権限がある統合エージェントは削除できます。
- 実行権限
-
JP1_Console_Admin
- APIのバージョン
-
v1
- 形式
-
- リクエスト行
POST /im/api/v1/agents/delete httpVersion
- リクエストのメッセージボディー
{ "agents": [ { "agenthost": 統合エージェントホスト名, "managerhost": マネージャーホスト名 }, ・・・ ] }- レスポンスのメッセージボディー
-
正常終了の場合，レスポンスはありません。
警告終了の場合，次のレスポンスを返却します。
{ "errhostlist":[ { "agenthost": 統合エージェントホスト名, "managerhost": マネージャーホスト名 },・・・ ], "messageList":[ { "messageId": メッセージID, "message": メッセージ }, ・・・ ] }
- パラメーター
-
リクエストのメッセージボディーに指定するパラメーターを次に示します。
パラメーター名
データ型
省略可否
説明
agents
object[]
不可
削除する統合エージェントを指定します。指定できる統合エージェントは200件までです。
空配列は指定できません。
agenthost
string
不可
統合エージェントのホスト名を1〜255バイトの範囲で指定します。
managerhost
string
不可
マネージャーホスト名を1〜255バイトの範囲で指定します。
- レスポンス
-
パラメーター名
データ型
省略可否
説明
errhostlist
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
インテリジェント統合管理基盤の処理でエラーが発生しました。
-
- 戻り値
-
なし
- 使用例
-
- リクエスト：
POST http://hostname:20703/im/api/v1/agents/delete { "agents": [ { "agenthost":"hostA", "managerhost":"hostB" } ] }- レスポンス：
< HTTP/1.1 200 OK < Content-Type: application/json