GET /switches/metrics/<UUID>

Use this GET method to retrieve a set of sample metrics for a specific Flex System switch. 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>/switches/metrics/<UUID>

where <UUID> is the UUID of the switch to be retrieved. To obtain the switch UUID, use the GET /switches 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.

Response codes

Code Description
200 OK.
400 Bad request.
403 Forbidden.
409 Conflict.
500 Internal server error.

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 Flex System switch
  averageSwitchModulePower Array of objects Average switch-module power samples
  minimumSwitchModulePower Array of objects Minimum switch-module power samples
  maximumSwitchModulePower Array of objects Maximum switch-module power samples
name String Switch name
parent Object Information about the chassis that contains the switch
  uuid String Chassis UUID
  uri String Chassis URI
uuid String Switch UUID
uri String Switch URI

Response example

{
    "energyMetrics": {
        "averageSwitchModulePower": [
            {
                "timeStamp": "2015-02-06T18:35:00Z",
                "metricValue": 29
            },
            ...
            {
                "timeStamp": "2015-02-06T18:49:59Z",
                "metricValue": 30
            },
        ],
        "minimumSwitchModulePower": [
            {
                "timeStamp": "2015-02-06T18:35:00Z",
                "metricValue": 29
            },
            ...
            {
                "timeStamp": "2015-02-06T18:45:00Z",
                "metricValue": 28
            },
        ],
        "maximumSwitchModulePower": [
            {
                "timeStamp": "2015-02-06T18:35:00Z",
                "metricValue": 31
            },
            ...
            {
                "timeStamp": "2015-02-06T18:45:00Z",
                "metricValue": 32
            },
        ]
    },
    "name": "IO Module 02",
    "parent": {
        "uuid": "3D1D5931BDF84D30ADA976E21F08CB91",
        "uri": "chassis/3D1D5931BDF84D30ADA976E21F08CB91"
    },
    "uuid": "1E3B957727F8E11180000002C96317EC",
    "uri": "switch/1E3B957727F8E11180000002C96317EC"
}