Since Product Version: 3.1
Resource URL
/webacs/api/v2/op/statisticsService/hostsRequest Parameters
Type | Attribute Name | Source | Description |
---|---|---|---|
String |
datacenter optional |
query |
Pattern to match the Datacenter name. If you do not specify any, all the Datacenters are considered. |
String |
cluster optional |
query |
Pattern to match the Cluster name. If you do not specify any, all the Clusters are considered. |
String |
host optional |
query |
Pattern to match the Hypervisor name. If you do not specify any, all the Clusters are considered. |
Boolean |
children optional |
query |
Parameter that needs to be set to true to fetch children of the Hypervisor. Children of a cluster are VMs that are part of it. |
String |
Range optional |
query |
Pagination range. |
Integer |
firstResult optional |
query |
TBD |
Integer |
maxResults optional |
query |
TBD |
String |
sort optional |
query |
|
Response Parameters
Type | Attribute Name | Description |
---|---|---|
resources |
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Response Payload
https://172.25.123.114/webacs/api/v2/op/statisticsService/hosts?datacenter="DC1"&cluster="CL1"&host="HOST1"&firstResult=0&maxResults=10&sort=-dnsConfigName
<?xml version="1.0" ?> <mgmtResponse responseType="operation" requestUrl="https://172.25.123.114/webacs/api/v2/op/statisticsService/hosts?datacenter=&quot;DC1&quot;&amp;cluster=&quot;CL1&quot;&amp;host=&quot;HOST1&quot;&amp;firstResult=0&amp;maxResults=10&amp;sort=-dnsConfigName " rootUrl="https://172.25.123.114/webacs/api/v1/op/"> <resourcesDTO> <resources> <resources> <childrenLink>String value</childrenLink> <description>String value</description> <details> <item key="String value"> <value xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">String value</value> </item> </details> <metricsLink>String value</metricsLink> <name>String value</name> <type>String value</type> </resources> </resources> </resourcesDTO> </mgmtResponse>
Sample JSON Response Payload
https://172.25.123.114/webacs/api/v2/op/statisticsService/hosts.json?datacenter="DC1"&cluster="CL1"&host="HOST1"&firstResult=0&maxResults=10&sort=-dnsConfigName
{ "mgmtResponse" : { "@requestUrl" : "https://172.25.123.114/webacs/api/v2/op/statisticsService/hosts?datacenter="DC1"&cluster="CL1"&host="HOST1"&firstResult=0&maxResults=10&sort=-dnsConfigName\n\t\t\t\t\t", "@responseType" : "operation", "@rootUrl" : "https://172.25.123.114/webacs/api/v1/op/", "resourcesDTO" : [ { "resources" : { "resources" : [ { "childrenLink" : "String value", "description" : "String value", "details" : [ { "@key" : "String value", "value" : "String value" } ], "metricsLink" : "String value", "name" : "String value", "type" : "String value" } ] } } ] } }