5.18.1　統合エージェント情報取得

機能

統合エージェントの情報を取得するAPIです。

統合マネージャーの配下に拠点/中継マネージャーが存在する場合，拠点/中継マネージャー配下の統合エージェントの情報も取得します。

ログインしたJP1ユーザーに参照権限がある場合は，エージェントの情報を取得します。

実行権限

JP1_Console_Admin

APIのバージョン

形式

リクエスト行

POST /im/api/v1/agents httpVersion

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

なし

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

{
  "agents": [
    統合エージェント情報オブジェクト, ...
  ],
  "messageList":[
    {
      "messageId": メッセージID,
      "message": メッセージ
    }, ...
}

パラメーター

なし

ステータスコード

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

ステータスコード	メッセージ	説明
200	−	APIの処理が成功しました。
403	KAJY01000-E	認証に使用したユーザーの権限が不足しています。
200	KAJY68500-W	マネージャーの統合エージェントホスト管理DBに接続できません。複数の管理マネージャーの統合エージェントホスト管理DBに接続できなかった場合はホスト名に各管理マネージャーホスト名を「,」で連結した文字列を指定します。
200	KAJY68204-W	マネージャーのインテリジェント統合管理基盤に接続できません。複数のマネージャーのインテリジェント統合管理基盤に接続できなかった場合はホスト名に各管理マネージャーホスト名を「,」で連結した文字列を指定します。
200	KAJY68210-W	インテリジェント統合管理基盤の処理でエラーが発生しました。
500	KAJY68501-E	マネージャーの統合エージェントホスト管理DBに接続できません。

戻り値

戻り値を次の表に示します。

パラメーター名	データ型	省略可否	説明
`agents`	object[]	不可	統合エージェント情報オブジェクトの配列を指定します。統合エージェントが存在しない場合は空の配列を指定します。
統合エージェント情報オブジェクト	object	可	「7.2.5(1) 統合エージェント情報オブジェクト」を参照してください。
`messageList`	object	可	メッセージオブジェクトの配列を指定します。メッセージが存在しない場合は省略されます。
`messageId`	string	不可	メッセージIDを指定します。
`message`	string	不可	メッセージ本文を指定します。使用される言語は，HTTPリクエストヘッダーのAccept-Languageプロパティの指定内容により決まります。

使用例

リクエスト：

POST http://hostname:20703/im/api/v1/agents

レスポンス：

< HTTP/1.1 200 OK
< Content-Type: application/json
{
     "agents": [
          {
               "agentid": "RENEMzNENDg5RkQyNEM2OT",
               "hostname": "agenthostA",
               "os": "windows",
               "installpath": "\\Program Files\\Hitachi\\jp1ima",
               "imversion": "130000",
               "managerhost": "managerhostA",
               "registeredtime": "2020-03-01T00:00:00Z",
               "addons": [
                    {
                         "addonName": "Windows metric collector(Windows exporter)",
                         "enables": true
                    }
               ]
          }
     ]
}

ページの先頭へ

5.18.1 統合エージェント情報取得

5.18.1　統合エージェント情報取得