2.2.1 Obtaining a List of Plug-in Information

This API request obtains a list of the plug-in information registered in JP1/OA.

Execution permission

Admin

API version

Request format

GET http[s]://host:port/Analytics/version/objects/Plugins

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "data":[{
            "instanceID":"...",
            "name":"...",
            "pluginId":"...",
            "protocolType":"...",
            "formatversion":"...",
            "pluginversion":"...",
            "pluginType":"...",
            "numOfRelatedResources":"...",
            "isCollector":"...",
            "status":"..."
        },
        :
        ],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

Attribute	Type	Description
data	Plugin[]	A list of Plugin objects. For details about Plugin, see the table below.
pagination	Pagination	Page information. This parameter is displayed only when the relevant resource exists.
count	int	Number of data items that meet the conditions.

data (Type: Plugin)

Attribute	Type	Description
instanceID	long	ID for identifying instances
name	string	Name of the plug-in
pluginId	string	ID for identifying the plug-in
protocolType	enum	Protocol used for connections to monitoring targets (For details about the specifiable values, see the table ProtocolType in List of enumerators.) The specifiable values are as follows: SNMP
formatversion	string	Format version of the plug-in
pluginversion	string	Version of the plug-in
pluginType	enum	Type of the plug-in (For details about the specifiable values, see the table PluginType in List of enumerators.) The specifiable values are as follows: NODE_PLUGIN
numOfRelatedResources	int	Number of resources found by using the plug-in
isCollector	boolean	Whether it is Collector
status	enum	Status of the plug-in (For details about the specifiable values, see the table PluginStatusType in List of enumerators.)

pagination (Type: Pagination)

Attribute	Type	Description
page	integer	page
pageSize	integer	Size of the pages
numPages	integer	Number of the pages
totalCount	integer	Number of the objects

Status codes

Status code	Reason phrase	Description
200	OK	Success.
401	Unauthorized	No login privilege.
403	Forbidden	No reference privilege.
412	Precondition Failed	The server is not available.
500	Internal Server Error	Server processing error.

Example code

[Request Header]
GET http://localhost:22015/Analytics/v1/objects/Plugins HTTP/1.1
Host: localhost:22015
User-Agent: Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:52.0) Gecko/20100101 Firefox/52.0
Accept: application/json
Accept-Language: ja
Content-Type: application/json
Authorization: Basic c3lzdGVtOm1hbmFnZXI=

[Response Header]
HTTP/1.1 200 OK
Date: Thu, 02 Aug 2018 05:26:16 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 62acd5efafe957ae5bcf4a65265bae4ebf8b0b1_Vlo8Y30JZAoRFn1MGwZuDwEDfF8=_V0810
X-Frame-Options: SAMEORIGIN
Keep-Alive: timeout=5, max=100
Connection: Keep-Alive
Content-Type: application/json

[Response Body]
{
  "data": [
    {
      "instanceID": 50,
      "name": "Sample 002 SNMP Node Plugin",
      "pluginId": "com.hitachi.software.ias.sample002",
      "protocolType": "SNMP",
      "formatversion": "0001",
      "pluginversion": "0001",
      "pluginType": "NODE_PLUGIN",
      "numOfRelatedResources": 2,
      "isCollector": false,
      "status": "ACTIVE"
    },
    {
      "instanceID": 0,
      "name": "Sample 001 SNMP Node Plugin",
      "pluginId": "com.hitachi.software.ias.sample001",
      "protocolType": "SNMP",
      "formatversion": "0001",
      "pluginversion": "0001",
      "pluginType": "NODE_PLUGIN",
      "numOfRelatedResources": 1,
      "isCollector": false,
      "status": "ACTIVE"
    }
  ],
  "count": 2
}