5.18.1 Retrieve integrated agent info

Description

This API is used to obtain integrated agent data.

If an office or relay manager exists under the control of Integrated manager, integrated agent under the control of the office or relay manager is also acquired.

If JP1 user you login has read permission, get agent info.

Execution permissions

JP1_Console_Admin

API version

v1

Format

Request line

POST /im/api/v1/agents httpVersion

Request message body

None

Response message body

{
  "agents": [
    integrated-agent-info-object, ...
  ],
  "messageList":[
    {
      "messageId": message-ID,
      "message": message
    }, ...
}

Parameters

None

Status codes

The following table describes the status codes that are returned as a response to the request:

Status code	Message	Description
200	--	API operation was successful.
403	KAJY01000-E	The permission of the user used for authentication is insufficient.
200	KAJY68500-W	Unable to connect to the manager's integrated agent host administration DB. If you are unable to connect to integrated agent host administration DB of more than one administration manager, specify host name with a concatenation of ",".
200	KAJY68204-W	Cannot connect to the manager's Intelligent Integrated Management Base. If you are unable to connect to Intelligent Integrated Management Base of more than one manager, specify host name with a concatenation of ',' for each manager.
200	KAJY68210-W	Intelligent Integrated Management Base operation encountered an error.
500	KAJY68501-E	Unable to connect to the manager's unified agent host management DB.

Return values

The following table describes the return value.

Parameter name	Data type	Optional	Description
agents	object[]	No	Specifies an array of integrated agent info objects. If integrated agent does not exist, specify an empty array.
integrated-agent-info-object	object	Yes	See 7.2.5(1) Integrated agent Info object.
messageList	object	Yes	Specifies an array of message objects. If message does not exist, it is omitted.
messageId	string	No	Specifies message ID.
message	string	No	Specifies message body. The language used is determined by Accept-Language property specification in HTTP request header.

Examples

Request:

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

Response:

< 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
                    }
               ]
          }
     ]
}

To Page Top