Skip to main content

GET /powerSupplies/metrics/{uuid}

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

Each sample is represented in terms of when the sample was taken (timeStamp) and the value of the sample (metricValue).

Authentication​

Authentication with username and password is required.

Request URL​

GET https://{management_server_IP}/powerSupplies/metrics/{uuid}

where {uuid} is the unique ID of the power supply to be retrieved.

Query parameters​

ParametersRequired / OptionalDescription
excludeAttributes={attributes}OptionalReturns 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}OptionalReturns 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​

CodeDescriptionComments
200OKThe request completed successfully.
400Bad RequestA 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.
403ForbiddenThe 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.
409ConflictThere is a conflict with the current state of the resource. A descriptive error message is returned in the response body.
500Internal Server ErrorAn 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).

AttributesTypeDescription
energyMetricsObjectEnergy metrics for the power supply
 averagePowerSupplyInputPowerArray of objectsAverage power-supply input power samples.
 maximumPowerSupplyInputPowerArray of objectsMinimum power-supply input power samples
 maximumPowerSupplyOutputPowerArray of objectsMaximum power-supply input power samples
 minimumPowerSupplyOutputPowerArray of objectsAverage power-supply output power samples
 minimumPowerSupplyInputPowerArray of objectsMinimum power-supply output power samples
 averagePowerSupplyOutputPowerArray of objectsMaximum power-supply output power samples
nameStringPower supply name
parentObjectInformation about the device that contains the power supply
 uuidStringParent UUID
 uriStringParent URI
uuidStringPower supply UUI
uriStringPower supply URI
The following example is returned if the request is successful.
{
   "energyMetrics": {
      "averagePowerSupplyInputPower": [{
         "timeStamp": "2015-02-06T20:10:00Z",
         "metricValue": 127
      },
      ...{
         "timeStamp": "2015-02-06T22:00:01Z",
         "metricValue": 128
      },
      {
         "timeStamp": "2015-02-06T22:05:00Z",
         "metricValue": 127
      }],
      "minimumPowerSupplyInputPower": [{
         "timeStamp": "2015-02-06T20:10:00Z",
         "metricValue": 125
      },
      ...{
         "timeStamp": "2015-02-06T22:00:01Z",
         "metricValue": 125
      },
      {
         "timeStamp": "2015-02-06T22:05:00Z",
         "metricValue": 126
      }],
      "maximumPowerSupplyInputPower": [{
         "timeStamp": "2015-02-06T20:10:00Z",
         "metricValue": 129
      },
      ...{
         "timeStamp": "2015-02-06T22:00:01Z",
         "metricValue": 130
      },
      {
         "timeStamp": "2015-02-06T22:05:00Z",
         "metricValue": 129
      }],
      "averagePowerSupplyOutputPower": [{
         "timeStamp": "2015-02-06T20:10:00Z",
         "metricValue": 102
      },
      ...{
         "timeStamp": "2015-02-06T22:00:01Z",
         "metricValue": 106
      },
      {
         "timeStamp": "2015-02-06T22:05:00Z",
         "metricValue": 109
      }]"minimumPowerSupplyOutputPower": [{
         "timeStamp": "2015-02-06T20:10:00Z",
         "metricValue": 98
      },
      ...{
         "timeStamp": "2015-02-06T22:00:01Z",
         "metricValue": 102
      },
      {
         "timeStamp": "2015-02-06T22:05:00Z",
         "metricValue": 101
      }],
      "maximumPowerSupplyOutputPower": [{
         "timeStamp": "2015-02-06T20:10:00Z",
         "metricValue": 112
      },
      ...{
         "timeStamp": "2015-02-06T22:00:01Z",
         "metricValue": 113
      },
      {
         "timeStamp": "2015-02-06T22:05:00Z",
         "metricValue": 113
      }],
      
   },
   "name": "Power Supply 01",
   "parent": {
      "uuid": "3D1D5931BDF84D30ADA976E21F08CB91",
      "uri": "chassis/3D1D5931BDF84D30ADA976E21F08CB91"
   },
   "uuid": "D15D67FD1FBC40A09BEDF97C061A160A",
   "uri": "powerSupply/D15D67FD1FBC40A09BEDF97C061A160A"
}