Skip to main content

GET /canisters/metrics/{uuid}

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

Request URL​

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

where {uuid} is the UUID of the storage controller to be retrieved. To obtain the storage-controller UUID, use the GET /canisters method.

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.
The following example returns averageSystemInputPower and averageSystemOutputPower properties in addition to the base properties.
GET https://192.0.2.0/canisters/metrics/6ED2CB368C594C66C2BB066D5A306138?
includeAttributes=averageSystemInputPower,averageSystemOutputPower

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 storage controller
 averageEffectiveCPUSpeedArrayAverage effective CPU speed samples
 maximumEffectiveCPUSpeedArrayMaximum effective CPU speed samples
 minimumEffectiveCPUSpeedArrayMinimum effective CPU speed samples
 averageCPUSubsystemPowerArrayAverage CPU subsystem power samples
 maximumCPUSubsystemPowerArrayMaximum CPU subsystem power samples
 minimumCPUSubsystemPowerArrayMinimum CPU subsystem power samples
 averageMemorySubsystemPowerArrayAverage memory subsystem power samples
 maximumMemorySubsystemPowerArrayMaximum memory subsystem power samples
 minimumMemorySubsystemPowerArrayMinimum memory subsystem power samples
 averageSystemInputPowerArrayAverage system input power samples
 maximumSystemInputPowerArrayMaximum system input power samples
 minimumSystemInputPowerArrayMinimum system input power samples
 averageSystemOutputPowerArrayAverage system output power samples
 maximumSystemOutputPowerArrayMaximum system output power samples
 minimumSystemOutputPowerArrayMinimum system output power samples
 inletAirTemperatureArrayInlet air temperature samples
 inletAirTemperature2ArrayInlet air temperature samples
 outletAirTemperatureArrayOutlet air temperature samples
nameStringStorage-controller name
parentArray 
 uriString 
 uuidString 
uriStringStorage-controller URI
uuidStringStorage-controller UUID
The following example is returned if the request is successful.
{
   "energyMetrics": {
      "averageCPUSubsystemPower": [{
         "timeStamp": "2015-02-06T16:06:00Z",
         "metricValue": 0
      },
      ...,
      {
         "timeStamp": "2015-02-06T17:05:30Z",
         "metricValue": 0
       }],
      "minimumCPUSubsystemPower": [{
         "timeStamp": "2015-02-06T16:06:00Z",
         "metricValue": 0
      },
      ...,
      {
         "timeStamp": "2015-02-06T17:05:30Z",
         "metricValue": 0
      }],
       "maximumCPUSubsystemPower": [{
         "timeStamp": "2015-02-06T16:06:00Z",
         "metricValue": 0
      },
      ...,
      {
         "timeStamp": "2015-02-06T17:05:30Z",
         "metricValue": 0
      }],
      "averageEffectiveCPUSpeed": [{
         "timeStamp": "2015-02-06T16:06:00Z",
         "metricValue": 0
      },
      ...,
      {
         "timeStamp": "2015-02-06T17:05:30Z",
         "metricValue": 0
      }],
      "minimumEffectiveCPUSpeed": [{
         "timeStamp": "2015-02-06T16:06:00Z",
         "metricValue": 0
      },
      ...,
      {
         "timeStamp": "2015-02-06T17:05:30Z",
         "metricValue": 0
      }],
      "maximumEffectiveCPUSpeed": [{
         "timeStamp": "2015-02-06T16:06:00Z",
         "metricValue": 0
      },
      ...,
      {
         "timeStamp": "2015-02-06T17:05:30Z",
         "metricValue": 0
      }],
      "averageMemorySubsystemPower": [{
         "timeStamp": "2015-02-06T16:06:00Z",
         "metricValue": 0
      },
      ...,
      {
         "timeStamp": "2015-02-06T17:05:30Z",
         "metricValue": 0
      }],
      "minimumMemorySubsystemPower": [{
         "timeStamp": "2015-02-06T16:06:00Z",
         "metricValue": 0
      },
      ...,
      {
          "timeStamp": "2015-02-06T17:05:30Z",
         "metricValue": 0
      }],
      "maximumMemorySubsystemPower": [{
          "timeStamp": "2015-02-06T16:06:00Z",
          "metricValue": 0
      },
      ...,
      {
         "timeStamp": "2015-02-06T17:05:30Z",
         "metricValue": 0
      }],
      "averageSystemInputPower": [{
         "timeStamp": "2015-02-06T16:06:00Z",
         "metricValue": 12
      },
      ...,
      {
         "timeStamp": "2015-02-06T17:05:30Z",
         "metricValue": 12
      }],
      "minimumSystemInputPower": [{
         "timeStamp": "2015-02-06T16:06:00Z",
         "metricValue": 0
      },
      ...,
      {
         "timeStamp": "2015-02-06T17:05:30Z",
          "metricValue": 0
      }],
      "maximumSystemInputPower": [{
          "timeStamp": "2015-02-06T16:06:00Z",
         "metricValue": 20
      },
      ...,
      {
         "timeStamp": "2015-02-06T17:05:30Z",
         "metricValue": 20
      }],
      "averageSystemOutputPower": [],
      "minimumSystemOutputPower": [],
      "maximumSystemOutputPower": [],
      "inletAirTemperature": [{
         "timeStamp": "2015-02-06T16:06:30Z",
         "metricValue": 21
      },
      ...,
      {
         "timeStamp": "2015-02-06T17:06:00Z",
         "metricValue": 21
      }],
      "inletAirTemperature2": [{
         "timeStamp": "2015-02-06T16:06:30Z",
         "metricValue": 21.5
      },
      ...,
      {
          "timeStamp": "2015-02-06T17:06:00Z",
         "metricValue": 21.5
      }],
      "outletAirTemperature": [],
   },
   "name": "xpet-c3s3",
   "parent": {
      "uri": "chassis/3D1D5931BDF84D30ADA976E21F08CB91",
      "uuid": "3D1D5931BDF84D30ADA976E21F08CB91"
   },
   "uri": "node/E33EB382679211E180BA5CF3FC7F1038",
   "uuid": "E33EB382679211E180BA5CF3FC7F1038"
}