2.9.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:

Collections

{
        "data":["...", ...],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

Attribute	Type	Description
data	anyType[]	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.

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

Hypervisor

{
        "instanceID":"...",
        "name":"...",
        "ipAddress":"...",
        "status":"...",
        "monitorStatus":"...",
        "description":"...",
        "collectorID":"...",
        "collectorName":"...",
        "autoCollectionType":"...",
        "clusterName":"...",
        "usedCredentialID":"...",
        "usedCredentials":"...",
        "hypervisorType":"...",
        "thresholdProfileID":"...",
        "thresholdProfileName":"...",
        "accessPointType":"...",
        "accessPointIpAddress":"...",
        "accessPointUser":"...",
        "groupIDs":["...", ...],
        "groupNames":["...", ...],
        "gradeNames":["...", ...],
        "gradeOrders":["...", ...]
}

Hypervisor (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 hyperviosr. (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
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
thresholdProfileID	long	ID of the threshold profile assigned to the hypervisor
thresholdProfileName	string	Name 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 VCENTER
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[]	ID of the grade of the consumer assigned to the hypervisor
gradeOrders	integer[]	Priority of the grade of the consumer assigned to the hypervisor

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
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 20:11:36 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 87d94e387ca516a82287ff4254ddac7f44e18bd4_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json


[Response Body]
{
  "data" : [ {
    "instanceID" : 4,
    "name" : "hyperV",
    "ipAddress" : "10.197.87.56",
    "status" : "Unknown",
    "monitorStatus" : "Manage",
    "description" : "Hyper-V 4C4C4544-0037-4710-8036-B7C04F504258",
    "usedCredentialID" : 9,
    "usedCredentials" : "10.197.87.56",
    "hypervisorType" : "HYPERV",
    "thresholdProfileID" : 23,
    "thresholdProfileName" : "Default Profile for Hyper-V",
    "accessPointType" : "WMI",
    "accessPointIpAddress" : "10.197.87.56",
    "accessPointUser" : "Administrator"
  }, {
    "instanceID" : 1,
    "name" : "172.17.17.181",
    "ipAddress" : "172.17.17.181",
    "status" : "Normal",
    "monitorStatus" : "Manage",
    "description" : "ESX 42234bf5-2c85-4bd6-7452-5b235faae0d2",
    "collectorID" : 0,
    "collectorName" : "172.17.17.115",
    "autoCollectionType" : "AutoConnect",
    "hypervisorType" : "ESX",
    "thresholdProfileID" : 6,
    "thresholdProfileName" : "Default Profile for ESX",
    "accessPointType" : "VCENTER",
    "accessPointIpAddress" : "172.17.17.115",
    "accessPointUser" : "Administrator"
  } ],  "count" : 2
}