Since Product Version: 3.1
Resource URL
/webacs/api/v2/op/statisticsService/vms/metrics/{metric}Request Parameters
Type | Attribute Name | Source | Description |
---|---|---|---|
String |
metric required |
path |
The metric name for which the data need to be fetched |
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. |
String |
vm optional |
query |
Pattern to match the VM name. If you do not specify any, all the Clusters are considered. |
Integer |
timeInterval required |
query |
Specifies the timeInterval of time (in hours). This field can contain values like 1,2,4,8,16,24, 168(1week), 336(2Week), 720(1Month), 8760(1Year). Note: Either the timeInterval parameter or the parameters startTime and endTime are required. The timeInterval parameter overrides the startTime and endTime parameters. |
Long |
startTime required |
query |
Specifies the start time in seconds to check the interface utilization summary from. (See timeInterval for more details) |
Long |
endTime required |
query |
Specifies the end time in seconds to check the interface utilization summary to. (See timeInterval for more details) |
Response Parameters
Type | Attribute Name | Description |
---|---|---|
String |
currentDateTime |
Current timestamp |
String |
description |
Metric description |
String |
metricName |
Metric name |
metricRows |
Metric data list |
|
String |
resourceName |
Resource name |
xValueProperty |
Properties of X values |
|
yValueProperty |
Properties of Y values |
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/vms/metrics/{metric}?datacenter="DC1"&cluster="CL1"&host="HOST1"&vm="VM1"&timeInterval=1
<?xml version="1.0" ?> <mgmtResponse responseType="operation" requestUrl="https://172.25.123.114/webacs/api/v2/op/statisticsService/vms/metrics/{metric}?datacenter=&quot;DC1&quot;&amp;cluster=&quot;CL1&quot;&amp;host=&quot;HOST1&quot;&amp;vm=&quot;VM1&quot;&amp;timeInterval=1 " rootUrl="https://172.25.123.114/webacs/api/v1/op/"> <metricData> <currentDateTime>String value</currentDateTime> <description>String value</description> <metricName>String value</metricName> <metricRows> <metricRows> <issue>String value</issue> <XValue>String value</XValue> <YLabels> <YLabels>String value</YLabels> </YLabels> <YValues> <YValues>15.0</YValues> </YValues> </metricRows> </metricRows> <resourceName>String value</resourceName> <XValueProperty> <label>String value</label> <unit>NUMBER</unit> </XValueProperty> <YValueProperty> <YValueProperty> <label>String value</label> <maxVal>4.0</maxVal> <minVal>4.0</minVal> <unit>NUMBER</unit> </YValueProperty> </YValueProperty> </metricData> </mgmtResponse>
Sample JSON Response Payload
https://172.25.123.114/webacs/api/v2/op/statisticsService/vms/metrics/{metric}.json?datacenter="DC1"&cluster="CL1"&host="HOST1"&vm="VM1"&timeInterval=1
{ "mgmtResponse" : { "@requestUrl" : "https://172.25.123.114/webacs/api/v2/op/statisticsService/vms/metrics/{metric}?datacenter="DC1"&cluster="CL1"&host="HOST1"&vm="VM1"&timeInterval=1\n\t\t\t\t\t", "@responseType" : "operation", "@rootUrl" : "https://172.25.123.114/webacs/api/v1/op/", "metricData" : [ { "currentDateTime" : "String value", "description" : "String value", "metricName" : "String value", "metricRows" : { "metricRows" : [ { "issue" : "String value", "xvalue" : "String value", "ylabels" : { "ylabels" : [ "String value" ] }, "yvalues" : { "yvalues" : [ 15.0 ] } } ] }, "resourceName" : "String value", "xvalueProperty" : { "label" : "String value", "unit" : "NUMBER" }, "yvalueProperty" : { "yvalueProperty" : [ { "label" : "String value", "maxVal" : 4.0, "minVal" : 4.0, "unit" : "NUMBER" } ] } } ] } }