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

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.
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

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 storage controller
  averageEffectiveCPUSpeed Array Average effective CPU speed samples
  maximumEffectiveCPUSpeed Array Maximum effective CPU speed samples
  minimumEffectiveCPUSpeed Array Minimum effective CPU speed samples
  averageCPUSubsystemPower Array Average CPU subsystem power samples
  maximumCPUSubsystemPower Array Maximum CPU subsystem power samples
  minimumCPUSubsystemPower Array Minimum CPU subsystem power samples
  averageMemorySubsystemPower Array Average memory subsystem power samples
  maximumMemorySubsystemPower Array Maximum memory subsystem power samples
  minimumMemorySubsystemPower Array Minimum memory subsystem power samples
  averageSystemInputPower Array Average system input power samples
  maximumSystemInputPower Array Maximum system input power samples
  minimumSystemInputPower Array Minimum system input power samples
  averageSystemOutputPower Array Average system output power samples
  maximumSystemOutputPower Array Maximum system output power samples
  minimumSystemOutputPower Array Minimum system output power samples
  inletAirTemperature Array Inlet air temperature samples
  inletAirTemperature2 Array Inlet air temperature samples
  outletAirTemperature Array Outlet air temperature samples
name String Storage-controller name
parent Array  
  uri String  
  uuid String  
uri String Storage-controller URI
uuid String Storage-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"
}