2.16.1 Obtaining Hypervisor List

The API acquires a list of hypervisors.

Execution permission

Admin, Modify

API version

Request format

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

Request body

Not applicable.

Response body

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

{
        "data":[{
            "instanceID":"...",
            "name":"...",
            "ipAddress":"...",
            "status":"...",
            "monitorStatus":"...",
            "description":"...",
            "collectorID":"...",
            "collectorName":"...",
            "autoCollectionType":"...",
            "clusterName":"...",
            "clusterStatus":"...",
            "usedCredentialID":"...",
            "usedCredentials":"...",
            "hypervisorType":"...",
            "hypervisorDetailType":"...",
            "thresholdProfileID":"...",
            "thresholdProfileName":"...",
            "originalThresholdProfileID":"...",
            "accessPointType":"...",
            "accessPointSnmpVersion":"...",
            "accessPointIpAddress":"...",
            "accessPointUser":"...",
            "groupIDs":["...", ...],
            "groupNames":["...", ...],
            "gradeNames":["...", ...],
            "gradeOrders":["...", ...],
            "pluginId":"..."
        },
        :
        ],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

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

Attribute	Type	Description
instanceID	long	ID of the hypervisor
name	string	Name of the hypervisor
ipAddress	string	IP address of the hypervisor
status	enum	Status of the hypervisor (For details about the specifiable values, see the table NodeStatusType in List of enumerators.) The specifiable values are as follows: Normal Warning Error Unreachable Unknown NotMonitored
monitorStatus	enum	Monitoring status of the hypervisor. (For details about the specifiable values, see the table ManagementLevelType in List of enumerators.) The specifiable values are as follows: New Manage ignore MonitorOff
description	string	Detailed information about the hypervisor
collectorID	long	ID for identifying a collector used for detection
collectorName	string	Name of a collector used for detection
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
clusterName	string	Name of the cluster where the hypervisor is registered
clusterStatus	enum	Status of the cluster where the hypervisor is registered (For details about the specifiable values, see the table NodeStatusType in List of enumerators.) The specifiable values are as follows: Normal Warning Error Unreachable Unknown NotMonitored
usedCredentialID	long	ID for identifying authentication information used for detection
usedCredentials	string	Name of authentication information used for detection
hypervisorType	string	Type of the hypervisor. The following the value can be specified. ・SERVER_ESX: ESX server ・SERVER_HYPERV: Hyper-V server ・GENERIC_HYPERVISOR: Hypervisor defined by plug-in
hypervisorDetailType	string	Type of the hypervisor that is defined by using the plug-in.
thresholdProfileID	long	ID of the threshold profile assigned to the hypervisor
thresholdProfileName	string	Name of the threshold profile assigned to the hypervisor
originalThresholdProfileID	string	Original threshold profile ID of the threshold profile assigned to the hypervisor
accessPointType	enum	Type of the protocol or collector for authentication information used for detection. (For details about the specifiable values, see the table ProtocolType in List of enumerators.) The specifiable values are as follows: WMI SNMP VCENTER
accessPointSnmpVersion	enum	SNMP version of credential (For details about the specifiable values, see the table SnmpVersion in List of enumerators.) The specifiable values are as follows: V1_V2C V3
accessPointIpAddress	string	IP address or host name used for connections to monitoring targets or management software
accessPointUser	string	User ID used for connections to monitoring targets or management software
groupIDs	long[]	ID of the consumer assigned to the hypervisor
groupNames	string[]	Name of the consumer assigned to the hypervisor
gradeNames	string[]	Name of the grade of the consumer assigned to the hypervisor
gradeOrders	integer[]	Priority of the grade of the consumer assigned to the hypervisor
pluginId	string	ID for the plug-in applied to the hypervisor.

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/Hypervisors HTTP/1.1
Host: JP1OAServer:22015
User-Agent: curl/7.63.0
Content-Type: application/json
Accept: application/json
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Accept-Language: ja

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 06 Sep 2019 09:40:40 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 6c538e8b65357bcc1674eef4d6cf6785014fca2_ZAlDSFUHGHp9UB8WcRQLdA==_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block 
X-Content-Type-Options: nosniff
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "data" : [ {
    "instanceID" : 453,
    "name" : "10.197.64.51",
    "ipAddress" : "10.197.64.51",
    "status" : "Normal",
    "monitorStatus" : "Manage",
    "description" : "HITACHI BladeSymphony F51 ffff-1c6f653231d4",
    "collectorID" : 452,
    "collectorName" : "vCenterServer",
    "autoCollectionType" : "AutoConnect",
    "hypervisorType" : "SERVER_ESX",
    "thresholdProfileID" : 6,
    "thresholdProfileName" : "Default Profile for ESX",
    "accessPointType" : "VCENTER",
    "accessPointIpAddress" : "10.197.64.50",
    "accessPointUser" : "admin",
    "groupIDs" : [ 0 ],
    "groupNames" : [ "#Unassigned Resources" ],
    "gradeNames" : [ "" ],
    "gradeOrders" : [ -1 ]
  }, {
    "instanceID" : 46,
    "name" : "10.197.64.62",
    "ipAddress" : "10.197.64.62",
    "status" : "Normal",
    "monitorStatus" : "Manage",
    "description" : "HITACHI HA8000/RS220 VMware ESXi ffffffff-ffff-ffff-ffff-1c6f65313f4e",
    "collectorID" : 452,
    "collectorName" : "vCenterServer",
    "autoCollectionType" : "AutoConnect",
    "hypervisorType" : "SERVER_ESX",
    "thresholdProfileID" : 6,
    "thresholdProfileName" : "Default Profile for ESX",
    "accessPointType" : "VCENTER",
    "accessPointIpAddress" : "10.197.64.50",
    "accessPointUser" : "admin",
    "groupIDs" : [ 0 ],
    "groupNames" : [ "#Unassigned Resources" ],
    "gradeNames" : [ "" ],
    "gradeOrders" : [ -1 ]
  }, {
    "instanceID" : 450,
    "name" : "hyper-v",
    "ipAddress" : "10.197.64.136, 10.197.64.167",
    "status" : "NotMonitored",
    "monitorStatus" : "MonitorOff",
    "description" : "Hyper-V  48930542-9AA8-220C-5B04-4136724A2D79",
    "usedCredentialID" : 450,
    "usedCredentials" : "hyper-v-auth",
    "hypervisorType" : "SERVER_HYPERV",
    "thresholdProfileID" : 23,
    "thresholdProfileName" : "Default Profile for Hyper-V",
    "accessPointType" : "WMI",
    "accessPointIpAddress" : "10.197.64.131",
    "accessPointUser" : "administrator",
    "groupIDs" : [ 0 ],
    "groupNames" : [ "#Unassigned Resources" ],
    "gradeNames" : [ "" ],
    "gradeOrders" : [ -1 ]
  }, {
    "instanceID" : 255,
    "name" : "esx2",
    "status" : "NotMonitored",
    "monitorStatus" : "MonitorOff",
    "description" : "Nutanix-1672e6be4fdfb05189fe6adf43858971a17d1b3d",
    "clusterName" : "HITACHI-NX",
    "usedCredentialID" : 300,
    "usedCredentials" : "hitachi nutanix",
    "hypervisorType" : "GENERIC_HYPERVISOR",
    "hypervisorDetailType" : "AHV",
    "accessPointType" : "SNMP",
    "accessPointSnmpVersion" : "V3",
    "accessPointIpAddress" : "10.197.64.111",
    "accessPointUser" : "admin",
    "groupIDs" : [ 160 ],
    "groupNames" : [ "Hitachi Cloud for JP1" ],
    "gradeNames" : [ "Platinum" ],
    "gradeOrders" : [ 0 ],
    "pluginId" : "com.hitachi.software.ias.NutanixPlugin"
  } ],
  "count" : 4
}