2.2.2 Obtaining Plug-in Information
This API request obtains information about the specified plug-in.
Execution permission
Admin
API version
v1
Request format
GET http[s]://host:port/Analytics/version/objects/Plugins/{id}
Request body
Not applicable.
Response body
The structure of the response body and the object attributes are as follows:{ "instanceID":"...", "name":"...", "pluginId":"...", "protocolType":"...", "formatversion":"...", "pluginversion":"...", "pluginType":"...", "numOfRelatedResources":"...", "isCollector":"...", "status":"..." }
Plugin (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:
|
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:
|
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.) |
Status codes
Status code |
Reason phrase |
Description |
---|---|---|
200 |
OK |
Success. |
401 |
Unauthorized |
No login privilege. |
403 |
Forbidden |
No reference privilege. |
404 |
Not Found |
The resource was not found. |
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/0 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:33:31 GMT Server: Cosminexus HTTP Server Cache-Control: no-cache WWW-Authenticate: HSSO e37f355445f0ffd3983bb9733cd5d3fed36d_Vlo8Y30JZAoRFn1MGwZuDwEDfF8=_V0810 X-Frame-Options: SAMEORIGIN x-xss-protection=1; mode=block X-Content-Type-Options=nosniff Keep-Alive: timeout=5, max=100 Connection: Keep-Alive Transfer-Encoding:chunked Content-Type: application/json [Response Body] { "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 }