GET /fans/metrics/{uuid}

Use this method to return a set of sample metrics for a specific Flex System fans. Each sample is represented in terms of when the sample was taken (timeStamp) and the value of the sample (metricValue).

Authentication

Authentication with user name and password is required.

Request URL

GET https://{management_server_IP}/fans/metrics/<UUID}

where <UUID} is the UUID of the fan to be retrieved. To obtain the fan UUID, use the GET /fans method.

Query parameters

Parameters Required / Optional Description
excludeAttributes={attributes} Optional Returns a response that excludes the specified attributes for each resource. You can specify one or more attributes that are listed in the response body, separated by a comma.
Note:
  • When the includeAttributes query parameter is specified, the excludeAttributes query parameter is ignored.
  • The response is filtered based on attribute name, not the attribute value.
  • Base attributes cannot be excluded.
includeAttributes=<attributes} Optional Returns a response that includes the base attributes and the specified attributes for each resource. You can specify one or more attributes that are listed in the response body, separated by a comma.
Note:
  • The response is filtered based on attribute name, not the attribute value.
  • If this attribute is not specified, all attributes are returned by default.

Request body

None

Response codes

Code Description Comments
200 OK The request completed successfully.
400 Bad Request A query parameter or request attribute is missing or not valid, or the operation is not supported. A descriptive error message is returned in the response body.
403 Forbidden The orchestrator server was prevented from fulfilling the request. A descriptive error message is returned in the response body. Ensure that you have privileges to perform the request.
409 Conflict There is a conflict with the current state of the resource. A descriptive error message is returned in the response body.
500 Internal Server Error An internal error occurred. A descriptive error message is returned in the response body.

Response body

Each energy metric contains one or more arrays that include when the sample was taken (timeStamp) and the value of the sample (metricValue).

Attributes Type Description
energyMetrics Object Energy metrics for the fan
  averageFanPower Array of objects Average fan power samples
  maximumFanPower Array of objects Maximum fan power samples
  minimumFanPower Array of objects Minimum fan power samples
name String Fan name
parent Array  
  uri String  
  uuid String  
uuid String Fan UUID
uri String Fan URI
The following example is returned if the request is successful.
{
   "energyMetrics": {
      "averageFanPower": [{
         "timeStamp": "2015-09-11T21:50:01Z",
         "metricValue": 7.0
      },
      ...,
      {
         "timeStamp": "2015-09-11T23:45:00Z",
         "metricValue": 8.0
      }],
      "maximumFanPower": [{
         "timeStamp": "2015-09-11T21:50:01Z",
         "metricValue": 8.0
      },
      ...,
      {
         "timeStamp": "2015-09-11T23:45:00Z",
         "metricValue": 8.0
      }]
      "minimumFanPower": [{
         "timeStamp": "2015-09-11T21:50:01Z",
         "metricValue": 7.0
      },
      ...,
      {
         "timeStamp": "2015-09-11T23:45:00Z",
         "metricValue": 8.0
      }],
   },
   "name": "Fan 08",
   "parent": {
      "uri": "chassis/8C070E3262114E36B7E68699386FBA53",
      "uuid": "8C070E3262114E36B7E68699386FBA53"
   },
   "uri": "fan/FD0021C1981E11E080EED0FD680CCBDA",
   "uuid": "FD0021C1981E11E080EED0FD680CCBDA"
}