HP OneView REST API Reference

enclosures
enclosures.html[10/17/2013 10:35:21 AM]
RatedCapacity
Enclosure dynamic power cap rated capacity setting in Watts during this
sample interval.
If unspecified, all metrics supported are returned.
filter Experimental Provides an expression of the requested time range of data. One condition
(startDate/endDate) is specified per filter specification as described below. The
condition must be specified via the equals (=) operator.
startDate
Start date of requested starting time range in ISO 8601 format. If omitted,
the startDate is determined by the endDate minus 24 hours.
endDate
End date of requested starting time range in ISO 8601 format. When
omitted the endDate includes the latest data sample available.
If an excessive number of samples would otherwise be returned, the results will be
segmented. The caller is responsible for comparing the returned sliceStartTime
with the requested startTime in the response. If the sliceStartTime is greater
than the oldestSampleTime and the requested start time, the caller is responsible
for repeating the request with endTime set to sliceStartTime to obtain the next
segment. This process is repeated until the full data set is retrieved.
If the resource has no data, the UtilizationData is still returned, but will contain no
samples and sliceStartTime/sliceEndTime will be equal.
oldestSampleTime/newestSampleTime will still be set appropriately (null if no
data is available). If the filter just does not happen to overlap the data that a
resource does have, then the metric history service will return null sample values for
any missing samples.
Request
Header
Attributes Description
REST API Request Headers NOTE: The X-API-Version header is required for all APIs. For the current release,
this must be set to "X-API-Version:3"
Response Description
UtilizationData Returns resource containing utilization data for the specified
enclosure.
Response Codes
REST API Response Codes
Examples
Get 24 hours of data for all available metrics at a resolution of one sample every 5
minutes for enclosure 09USE7335NW3:
GET https://{appl}/rest/enclosures/09USE7335NW3/utilization
Get temperature data for enclosure 09USE7335NW3 between two specified
dates at
a resolution of one sample per hour:
GET https://{appl}/rest/enclosures/09USE7335NW3/utilization?
fields=AmbientTemperature
&view=hour&filter=startDate=20120401T202800.000Z&filter=endDate=20120402T202800.000Z
Get all temperature data at a resolution of one sample per day for
enclosure 09USE7335NW3:
GET https://{appl}/rest/enclosures/09USE7335NW3/utilization?view=day