Since Product Version: 3.1
Resource URL
/webacs/api/v2/op/statisticsService/clusters/metricsRequest 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. |
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 |
info |
Metrics info |
metrics |
Metric details list |
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/clusters/metrics?datacenter="DC1"&cluster="CL1"&timeInterval=1
<?xml version="1.0" ?> <mgmtResponse responseType="operation" requestUrl="https://172.25.123.114/webacs/api/v2/op/statisticsService/clusters/metrics?datacenter=&quot;DC1&quot;&amp;cluster=&quot;CL1&quot;&amp;timeInterval=1 " rootUrl="https://172.25.123.114/webacs/api/v1/op/"> <metricsDTO> <info>String value</info> <metrics> <metrics> <description>String value</description> <name>String value</name> <type>TIME_SERIES</type> <units> <units>NUMBER</units> </units> <url>String value</url> </metrics> </metrics> </metricsDTO> </mgmtResponse>
Sample JSON Response Payload
https://172.25.123.114/webacs/api/v2/op/statisticsService/clusters/metrics.json?datacenter="DC1"&cluster="CL1"&timeInterval=1
{ "mgmtResponse" : { "@requestUrl" : "https://172.25.123.114/webacs/api/v2/op/statisticsService/clusters/metrics?datacenter="DC1"&cluster="CL1"&timeInterval=1\n\t\t\t\t\t", "@responseType" : "operation", "@rootUrl" : "https://172.25.123.114/webacs/api/v1/op/", "metricsDTO" : [ { "info" : "String value", "metrics" : { "metrics" : [ { "description" : "String value", "name" : "String value", "type" : "TIME_SERIES", "units" : { "units" : [ "NUMBER" ] }, "url" : "String value" } ] } } ] } }