API version v1 is deprecated
This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.
Resource unavailable for this API version
This resource was introduced in API version 2.
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v2/op/statisticsService/datacenters/metrics/{metric}
Request Parameters
metric
String
|
path
|
RequiredThe metric name for which the data need to be fetched
|
datacenter
String
|
query
|
OptionalPattern to match the Datacenter name. If you do not specify any, all the Datacenters are considered.
|
timeInterval
Integer
|
query
|
RequiredSpecifies 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.
|
startTime
Long
|
query
|
RequiredSpecifies the start time in seconds to check the interface utilization summary from. (See timeInterval for more details)
|
endTime
Long
|
query
|
RequiredSpecifies the end time in seconds to check the interface utilization summary to. (See timeInterval for more details)
|
Response Parameters
currentDateTime
String
|
|
description
String
|
|
metricName
String
|
|
metricRows
MetricRowDTO[]
|
|
issue
String
|
|
xValue
String
|
|
yValues
Double[]
|
|
|
resourceName
String
|
|
xValueProperty
XValueProperty
|
|
label
String
|
|
unit
MetricUnitEnum
|
Unit for X
Allowed values:
- NUMBER
- STRING
- PERCENTAGE
- SECOND
- MILLISECOND
- BYTE
- KB
- MB
- BITS_PER_SECOND
- BYTES_PER_SECOND
- KB_PER_SEC
- HERTZ
- MEGAHERTZ
- DISC_UNIT
- NETWORK_UNIT
|
|
yValueProperty
YValueProperty[]
|
|
label
String
|
|
maxVal
double
|
|
minVal
double
|
|
unit
MetricUnitEnum
|
Unit for Y
Allowed values:
- NUMBER
- STRING
- PERCENTAGE
- SECOND
- MILLISECOND
- BYTE
- KB
- MB
- BITS_PER_SECOND
- BYTES_PER_SECOND
- KB_PER_SEC
- HERTZ
- MEGAHERTZ
- DISC_UNIT
- NETWORK_UNIT
|
|
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://localhost/webacs/api/v2/op/statisticsService/datacenters/metrics/{metric}?datacenter="DC1"&timeInterval=1
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v2/op/statisticsService/datacenters/metrics/{metric}?datacenter=&quot;DC1&quot;&amp;timeInterval=1
" rootUrl="https://localhost/webacs/api/v2/op">
<metricData>
<currentDateTime>String value</currentDateTime>
<description>String value</description>
<metricName>String value</metricName>
<metricRows>
<metricRows>
<issue>String value</issue>
<XValue>String value</XValue>
<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://localhost/webacs/api/v2/op/statisticsService/datacenters/metrics/{metric}.json?datacenter="DC1"&timeInterval=1
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v2/op/statisticsService/datacenters/metrics/{metric}?datacenter="DC1"&timeInterval=1\n\t\t\t\t\t",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v2/op",
"metricData" : [ {
"XValueProperty" : {
"label" : "String value",
"unit" : "NUMBER"
},
"YValueProperty" : {
"yvalueProperty" : [ {
"label" : "String value",
"maxVal" : 4.0,
"minVal" : 4.0,
"unit" : "NUMBER"
} ]
},
"currentDateTime" : "String value",
"description" : "String value",
"metricName" : "String value",
"metricRows" : {
"metricRows" : [ {
"XValue" : "String value",
"YValues" : {
"yvalues" : [ 15.0 ]
},
"issue" : "String value"
} ]
},
"resourceName" : "String value"
} ]
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v3/op/statisticsService/datacenters/metrics/{metric}
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
metric
String
|
path
|
RequiredThe metric name for which the data need to be fetched
|
datacenter
String
|
query
|
OptionalPattern to match the Datacenter name. If you do not specify any, all the Datacenters are considered.
|
timeInterval
Integer
|
query
|
RequiredSpecifies 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.
|
startTime
Long
|
query
|
RequiredSpecifies the start time in seconds to check the interface utilization summary from. (See timeInterval for more details)
|
endTime
Long
|
query
|
RequiredSpecifies the end time in seconds to check the interface utilization summary to. (See timeInterval for more details)
|
Response Parameters
currentDateTime
String
|
|
description
String
|
|
metricName
String
|
|
metricRows
MetricRowDTO[]
|
|
issue
String
|
|
xValue
String
|
|
yValues
Double[]
|
|
|
resourceName
String
|
|
xValueProperty
XValueProperty
|
|
label
String
|
|
unit
MetricUnitEnum
|
Unit for X
Allowed values:
- NUMBER
- STRING
- PERCENTAGE
- SECOND
- MILLISECOND
- BYTE
- KB
- MB
- BITS_PER_SECOND
- BYTES_PER_SECOND
- KB_PER_SEC
- HERTZ
- MEGAHERTZ
- DISC_UNIT
- NETWORK_UNIT
|
|
yValueProperty
YValueProperty[]
|
|
label
String
|
|
maxVal
double
|
|
minVal
double
|
|
unit
MetricUnitEnum
|
Unit for Y
Allowed values:
- NUMBER
- STRING
- PERCENTAGE
- SECOND
- MILLISECOND
- BYTE
- KB
- MB
- BITS_PER_SECOND
- BYTES_PER_SECOND
- KB_PER_SEC
- HERTZ
- MEGAHERTZ
- DISC_UNIT
- NETWORK_UNIT
|
|
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://localhost/webacs/api/v3/op/statisticsService/datacenters/metrics/{metric}?datacenter="DC1"&timeInterval=1
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v3/op/statisticsService/datacenters/metrics/{metric}?datacenter=&quot;DC1&quot;&amp;timeInterval=1
" rootUrl="https://localhost/webacs/api/v3/op">
<metricData>
<currentDateTime>String value</currentDateTime>
<description>String value</description>
<metricName>String value</metricName>
<metricRows>
<metricRows>
<issue>String value</issue>
<XValue>String value</XValue>
<YValues>
<YValues>15.0</YValues>
<YValues>25.0</YValues>
</YValues>
</metricRows>
<metricRows>
<issue>Another string value</issue>
<XValue>Another string value</XValue>
<YValues>
<YValues>15.0</YValues>
<YValues>25.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>
<label>Another string value</label>
<maxVal>14.0</maxVal>
<minVal>14.0</minVal>
<unit>STRING</unit>
</YValueProperty>
</YValueProperty>
</metricData>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v3/op/statisticsService/datacenters/metrics/{metric}.json?datacenter="DC1"&timeInterval=1
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v3/op/statisticsService/datacenters/metrics/{metric}?datacenter="DC1"&timeInterval=1\n\t\t\t\t\t",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v3/op",
"metricData" : [ {
"XValueProperty" : {
"label" : "String value",
"unit" : "NUMBER"
},
"YValueProperty" : {
"yvalueProperty" : [ {
"label" : "String value",
"maxVal" : 4.0,
"minVal" : 4.0,
"unit" : "NUMBER"
}, {
"label" : "Another string value",
"maxVal" : 14.0,
"minVal" : 14.0,
"unit" : "STRING"
} ]
},
"currentDateTime" : "String value",
"description" : "String value",
"metricName" : "String value",
"metricRows" : {
"metricRows" : [ {
"XValue" : "String value",
"YValues" : {
"yvalues" : [ 15.0, 25.0 ]
},
"issue" : "String value"
}, {
"XValue" : "Another string value",
"YValues" : {
"yvalues" : [ 15.0, 25.0 ]
},
"issue" : "Another string value"
} ]
},
"resourceName" : "String value"
} ]
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v4/op/statisticsService/datacenters/metrics/{metric}
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
metric
String
|
path
|
RequiredThe metric name for which the data need to be fetched
|
datacenter
String
|
query
|
OptionalPattern to match the Datacenter name. If you do not specify any, all the Datacenters are considered.
|
timeInterval
Integer
|
query
|
RequiredSpecifies 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.
|
startTime
Long
|
query
|
RequiredSpecifies the start time in seconds to check the interface utilization summary from. (See timeInterval for more details)
|
endTime
Long
|
query
|
RequiredSpecifies the end time in seconds to check the interface utilization summary to. (See timeInterval for more details)
|
Response Parameters
currentDateTime
String
|
|
description
String
|
|
metricName
String
|
|
metricRows
MetricRowDTO[]
|
|
issue
String
|
|
xValue
String
|
|
yValues
Double[]
|
|
|
resourceName
String
|
|
xValueProperty
XValueProperty
|
|
label
String
|
|
unit
MetricUnitEnum
|
Unit for X
Allowed values:
- NUMBER
- STRING
- PERCENTAGE
- SECOND
- MILLISECOND
- BYTE
- KB
- MB
- BITS_PER_SECOND
- BYTES_PER_SECOND
- KB_PER_SEC
- HERTZ
- MEGAHERTZ
- DISC_UNIT
- NETWORK_UNIT
|
|
yValueProperty
YValueProperty[]
|
|
label
String
|
|
maxVal
double
|
|
minVal
double
|
|
unit
MetricUnitEnum
|
Unit for Y
Allowed values:
- NUMBER
- STRING
- PERCENTAGE
- SECOND
- MILLISECOND
- BYTE
- KB
- MB
- BITS_PER_SECOND
- BYTES_PER_SECOND
- KB_PER_SEC
- HERTZ
- MEGAHERTZ
- DISC_UNIT
- NETWORK_UNIT
|
|
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://localhost/webacs/api/v4/op/statisticsService/datacenters/metrics/{metric}?datacenter="DC1"&timeInterval=1
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v4/op/statisticsService/datacenters/metrics/{metric}?datacenter=&quot;DC1&quot;&amp;timeInterval=1
" rootUrl="https://localhost/webacs/api/v4/op">
<metricData>
<currentDateTime>String value</currentDateTime>
<description>String value</description>
<metricName>String value</metricName>
<metricRows>
<metricRows>
<issue>String value</issue>
<XValue>String value</XValue>
<YValues>
<YValues>15.0</YValues>
<YValues>25.0</YValues>
</YValues>
</metricRows>
<metricRows>
<issue>Another string value</issue>
<XValue>Another string value</XValue>
<YValues>
<YValues>15.0</YValues>
<YValues>25.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>
<label>Another string value</label>
<maxVal>14.0</maxVal>
<minVal>14.0</minVal>
<unit>STRING</unit>
</YValueProperty>
</YValueProperty>
</metricData>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v4/op/statisticsService/datacenters/metrics/{metric}.json?datacenter="DC1"&timeInterval=1
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v4/op/statisticsService/datacenters/metrics/{metric}?datacenter="DC1"&timeInterval=1\n\t\t\t\t\t",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v4/op",
"metricData" : [ {
"XValueProperty" : {
"label" : "String value",
"unit" : "NUMBER"
},
"YValueProperty" : {
"yvalueProperty" : [ {
"label" : "String value",
"maxVal" : 4.0,
"minVal" : 4.0,
"unit" : "NUMBER"
}, {
"label" : "Another string value",
"maxVal" : 14.0,
"minVal" : 14.0,
"unit" : "STRING"
} ]
},
"currentDateTime" : "String value",
"description" : "String value",
"metricName" : "String value",
"metricRows" : {
"metricRows" : [ {
"XValue" : "String value",
"YValues" : {
"yvalues" : [ 15.0, 25.0 ]
},
"issue" : "String value"
}, {
"XValue" : "Another string value",
"YValues" : {
"yvalues" : [ 15.0, 25.0 ]
},
"issue" : "Another string value"
} ]
},
"resourceName" : "String value"
} ]
}
}