2.5.1 Obtaining Collector List

This API acquires a list of collectors to be used by JP1/OA for connections to management software.

Execution permission

Admin, Modify

API version

Request format

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

Request body

Not applicable.

Response body

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

{
        "data":[{
            "instanceID":"...",
            "name":"...",
            "collectorType":"...",
            "osType":"...",
            "autoCollectionType":"...",
            "connectResult":"...",
            "refreshStatus":"...",
            "message":"...",
            "lastRefreshed":"...",
            "refreshDateForInventory":"...",
            "refreshDateForPerformance":"...",
            "refreshDateForState":"...",
            "numOfHypervisors":"...",
            "numOfVms":"...",
            "numOfHosts":"...",
            "numOfApplications":"...",
            "numOfContainers":"...",
            "numOfServices":"...",
            "numOfResources":"...",
            "collectorCredentials":[{
                "requireHostAddress":"...",
                "ipAddress":"...",
                "accessTargetIdentification":"...",
                "userId":"...",
                "portNumber":"...",
                "hypertextTransferProtocolType":"...",
                "domainName":"...",
                "useAdministrativeShares":"...",
                "shareName":"...",
                "sharedFolder":"...",
                "logicalHostName":"...",
                "useLogicalHostName":"..."
            },
            :
            ],
            "productName":"...",
            "providerName":"...",
            "refreshDateForApp":"...",
            "plugin":{
                "instanceID":"...",
                "name":"...",
                "pluginId":"...",
                "protocolType":"...",
                "formatversion":"...",
                "pluginversion":"...",
                "pluginType":"...",
                "numOfRelatedResources":"...",
                "isCollector":"...",
                "status":"..."
            }
        },
        :
        ],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

Attribute	Type	Description
data	Collector[]	A list of Collector objects. For details about Collector, 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: Collector)

Attribute	Type	Description
instanceID	long	ID for identifying instances.
name	string	Collector name
collectorType	enum	Collector type. (For details about the specifiable values, see the table ProtocolType in List of enumerators.) The specifiable values are as follows: VCENTER AJS PFM IM CUSTOM HTTP
osType	enum	Type of OS. This member is only set when the collectorType is AJS, PFM, or IM. (For details about the specifiable values, see the table CollectorOsType in List of enumerators.)
autoCollectionType	enum	Settings for periodic executions of the collector. (For details about the specifiable values, see the table ConnectType in List of enumerators.) The specifiable values are as follows: AutoConnect NotAutoConnect
connectResult	enum	Last execution result of the collector. (For details about the specifiable values, see the table ConnectStatusType in List of enumerators.) The specifiable values are as follows: NoConnect Succeeded Failed
refreshStatus	enum	Execution status of the collector. (For details about the specifiable values, see the table ConnectStatusType in List of enumerators.) The specifiable values are as follows: NoConnect InProgress
message	string	Message of the execution result of the collector
lastRefreshed	dateTime	The date and time when information for the following was last updated: ・refreshDateForInventory ・refreshDateForPerformance ・refreshDateForState
refreshDateForInventory	dateTime	Refresh date and time for the configuration information
refreshDateForPerformance	dateTime	Refresh date and time for the performance information
refreshDateForState	dateTime	Date and time when the state information is to be refreshed. This value can be obtained when all of the following conditions are met: ・The type of collector is VCENTER. ・The collection interval settings of "Status Monitoring (VM/Hypervisor)" are enabled.
numOfHypervisors	int	Number of hypervisors found by the collector
numOfVms	int	Number of virtual machines found by the collector
numOfHosts	int	Number of virtual machines found by the collector
numOfApplications	int	Number of applications found by the collector.
numOfContainers	int	Number of container nodes found by the collector.
numOfServices	int	Number of service resources found by the collector.
numOfResources	int	Number of management resources found by the collector.
collectorCredentials	CollectorCredential[]	Authentication information used for connections to monitoring targets.
productName	string	Collected-product name. This value can be obtained when the collectorType is CUSTOM_APP.
providerName	string	Provider name. This value can be obtained when the collectorType is CUSTOM_APP.
refreshDateForApp	dateTime	Date definition was applied. This value can be obtained when the collectorType is CUSTOM_APP.
plugin	Plugin	Defail information of the plug-in applied to the collector

collectorCredentials (Type: CollectorCredential)

Attribute	Type	Description
requireHostAddress	boolean	A flag that determines if an IP address or host name is required - true: An IP address is required. An access-target identification key is not required. - false: An IP address is not required. An access-target identification key is required. This is used for the HTTP protocol.
ipAddress	string	IP address or host name used for connections to management software.
accessTargetIdentification	string	Access-target identification key (when no IP address is specified)
userId	string	User ID used for connections to management software. Specify a string of 255 or fewer bytes.
portNumber	int	Port number used for connections to management software.
hypertextTransferProtocolType	enum	Whether to use SSL (HTTPS) for connections to management software. (For details about the specifiable values, see the table HypertextTransferProtocolType in List of enumerators.) The specifiable values are as follows: HTTP HTTPS
domainName	string	Domain name: Used for application linkage when Windows is selected.
useAdministrativeShares	boolean	To share management, set true.
shareName	string	share Name
sharedFolder	string	shared Folder
logicalHostName	string	Logical Host Name
useLogicalHostName	boolean	To use logical host name, set true.

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: 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 /Analytics/v1/objects/Collectors HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Accept-Language: ja


[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 05:21:49 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO b9719717b548c1da1798ed5a2b2c22dbda7f40cd_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json


[Response Body]
{
  "data" : [ {
    "instanceID" : 0,
    "name" : "192.168.0.115",
    "collectorType" : "VCENTER",
    "autoCollectionType" : "AutoConnect",
    "connectResult" : "Succeeded",
    "refreshStatus" : "NoConnect",
    "lastRefreshed" : "2015-11-27T14:17:09.160+09:00",
    "refreshDateForInventory" : "2015-11-27T13:25:03.943+09:00",
    "refreshDateForPerformance" : "2015-11-27T14:17:09.160+09:00",
    "refreshDateForState": "2015-11-27T13:36:45.725+09:00",
    "numOfHypervisors" : 2,
    "numOfVms" : 27,
    "numOfApplications": 12,
    "numOfContainers": 0,
    "numOfServices": 0,
    "numOfResources": 0,
    "collectorCredentials" : [ {
      "ipAddress" : "192.168.0.115",
      "userId" : "Administrator",
      "portNumber" : 443,
      "hypertextTransferProtocolType" : "HTTPS"
    } ]
  },
  {
    "instanceID": 1,
    "name": "jp1ajs_v11",
    "collectorType": "AJS",
    "osType": "Windows",
    "autoCollectionType": "AutoConnect",
    "connectResult": "Succeeded",
    "refreshStatus": "NoConnect",
    "lastRefreshed": "2017-09-26T00:46:59.296+09:00",
    "refreshDateForInventory": "2017-09-26T00:46:59.296+09:00",
    "numOfHypervisors": 0,
    "numOfVms": 0,
    "numOfApplications": 12,
    "numOfContainers": 0,
    "numOfServices": 0,
    "numOfResources": 0,
    "collectorCredentials":
    [
      {
        "ipAddress": "192.168.1.118",
        "userId": "administrator",
        "domainName": "",
        "useAdministrativeShares": true,
        "useLogicalHostName": false
      }
    ]
  },
  {
    "instanceID": 3,
    "name": "customCollector",
    "collectorType": "CUSTOM",
    "autoCollectionType": "AutoConnect",
    "connectResult": "Succeeded",
    "refreshStatus": "NoConnect",
    "lastRefreshed": "2017-09-26T10:15:26.991+09:00",
    "refreshDateForInventory": "2017-09-26T10:15:26.991+09:00",
    "numOfHypervisors": 0,
    "numOfVms": 0,
    "numOfApplications": 10,
    "numOfContainers": 0,
    "numOfServices": 0,
    "numOfResources": 0,
    "productName": "User Product",
    "providerName": "XXYY System",
    "refreshDateForApp": "2017-08-04T12:10:00.775+09:00"
  }
],
  "count" : 3
}