
Cisco Evolved Programmable Network Manager API
Evolved Programmable Network Manager API Documentation

# GET statisticsService/clusters/metrics/{metric}

Deprecated

Data Center support has been deprecated. Use DCNM for NXOS deployments and ACI for ACI-mode Deployments for data-center devices.

Fetches the metric data for a Cluster

Since Product Version: 3.1

- Jump To

- v1
- v2
- v3
- v4

API version v1 is deprecated

This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.

Resource unavailable for this API version

This resource was introduced in API version 2.

### Resource Information

Rate Limiting? | No
Sorting? | No
Paging? | No
Filtering? | No
Group Filtering? | No
Aggregation? | No
Response Formats | xml json
User Group | NBI Read
HTTP Methods | GET

## Resource URL

/webacs/api/v2/op/statisticsService/clusters/metrics/{metric}

## Request Parameters

Attribute | Source | Description
--- | --- | ---
metric String | path | Required The metric name for which the data need to be fetched
datacenter String | query | Optional Pattern to match the Datacenter name. If you do not specify any, all the Datacenters are considered.
cluster String | query | Optional Pattern to match the Cluster name. If you do not specify any, all the Clusters are considered.
timeInterval Integer | query | Required Specifies the timeInterval of time (in hours). This field can contain values like 1,2,4,8,16,24, 168(1week), 336(2Week), 720(1Month), 8760(1Year). Note: Either the timeInterval parameter or the parameters startTime and endTime are required. The timeInterval parameter overrides the startTime and endTime parameters.
startTime Long | query | Required Specifies the start time in seconds to check the interface utilization summary from. (See timeInterval for more details)
endTime Long | query | Required Specifies the end time in seconds to check the interface utilization summary to. (See timeInterval for more details)

## Response Parameters

Attribute | Description
--- | ---
currentDateTime String | Current timestamp
description String | Metric description
metricName String | Metric name
metricRows MetricRowDTO[] | Metric data list
Attribute | Description
--- | ---
issue String |
xValue String | X value
yLabels String[] | y label
yValues Double[] | Y value
resourceName String | Resource name
xValueProperty XValueProperty | Properties of X values
Attribute | Description
--- | ---
label String | Label for X
unit MetricUnitEnum | Unit for X Allowed values NUMBER STRING PERCENTAGE SECOND MILLISECOND BYTE KB MB BITS_PER_SECOND BYTES_PER_SECOND PACKETS FRAMES_PER_SECOND KB_PER_SEC HERTZ MEGAHERTZ DISC_UNIT NETWORK_UNIT DBM VOLT MICROSECOND MILLIAMP CELSIUS DECIBEL KBITS_PER_SEC BUFFER_UNDER_RUN_TIMES FAILURE_COUNT PS PS2 RAD_PER_SECOND DB RATIO ERROR_SECONDS CODE_VIOLATIONS BLOCK_ERRORS UNCORRECTABLE_WORDS BIT_ERRORS BLOCKS MA ERRORS BIT_ERRORS_RATE BIT BUFFER_OVERRUN_TIMES N_A PACKETS_PER_SECOND
yValueProperty YValueProperty[] | Properties of Y values
Attribute | Description
--- | ---
label String | Label for Y
maxVal double | Maximum of Y values
minVal double | Minimum of Y values
unit MetricUnitEnum | Unit for Y Allowed values NUMBER STRING PERCENTAGE SECOND MILLISECOND BYTE KB MB BITS_PER_SECOND BYTES_PER_SECOND PACKETS FRAMES_PER_SECOND KB_PER_SEC HERTZ MEGAHERTZ DISC_UNIT NETWORK_UNIT DBM VOLT MICROSECOND MILLIAMP CELSIUS DECIBEL KBITS_PER_SEC BUFFER_UNDER_RUN_TIMES FAILURE_COUNT PS PS2 RAD_PER_SECOND DB RATIO ERROR_SECONDS CODE_VIOLATIONS BLOCK_ERRORS UNCORRECTABLE_WORDS BIT_ERRORS BLOCKS MA ERRORS BIT_ERRORS_RATE BIT BUFFER_OVERRUN_TIMES N_A PACKETS_PER_SECOND

## Sample Payloads

Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.

### Sample XML Response Payload

https://172.20.127.108/webacs/api/v2/op/statisticsService/clusters/metrics/cpuUsage?datacenter="DC1"&cluster="CL1"&timeInterval=1

    <?xml version="1.0" ?>
    <mgmtResponse responseType="operation" requestUrl="https://172.20.127.108/webacs/api/v2/op/statisticsService/clusters/metrics/cpuUsage?datacenter=&amp;quot;DC1&amp;quot;&amp;amp;cluster=&amp;quot;CL1&amp;quot;&amp;amp;timeInterval=1
    					" rootUrl="https://172.20.127.108/webacs/api/v2/op">
      <metricData>
        <currentDateTime>String value</currentDateTime>
        <description>String value</description>
        <metricName>String value</metricName>
        <metricRows>
          <metricRows>
            <issue>String value</issue>
            <XValue>String value</XValue>
            <YLabels>
              <YLabels>String value</YLabels>
              <YLabels>Another string value</YLabels>
            </YLabels>
            <YValues>
              <YValues>15.0</YValues>
              <YValues>25.0</YValues>
            </YValues>
          </metricRows>
          <metricRows>
            <issue>Another string value</issue>
            <XValue>Another string value</XValue>
            <YLabels>
              <YLabels>String value</YLabels>
              <YLabels>Another string value</YLabels>
            </YLabels>
            <YValues>
              <YValues>15.0</YValues>
              <YValues>25.0</YValues>
            </YValues>
          </metricRows>
        </metricRows>
        <resourceName>String value</resourceName>
        <XValueProperty>
          <label>String value</label>
          <unit>NUMBER</unit>
        </XValueProperty>
        <YValueProperty>
          <YValueProperty>
            <label>String value</label>
            <maxVal>4.0</maxVal>
            <minVal>4.0</minVal>
            <unit>NUMBER</unit>
          </YValueProperty>
          <YValueProperty>
            <label>Another string value</label>
            <maxVal>14.0</maxVal>
            <minVal>14.0</minVal>
            <unit>STRING</unit>
          </YValueProperty>
        </YValueProperty>
      </metricData>
    </mgmtResponse>

### Sample JSON Response Payload

https://172.20.127.108/webacs/api/v2/op/statisticsService/clusters/metrics/cpuUsage.json?datacenter="DC1"&cluster="CL1"&timeInterval=1

    {
      "mgmtResponse" : {
        "@requestUrl" : "https://172.20.127.108/webacs/api/v2/op/statisticsService/clusters/metrics/cpuUsage?datacenter=&quot;DC1&quot;&amp;cluster=&quot;CL1&quot;&amp;timeInterval=1\n\t\t\t\t\t",
        "@responseType" : "operation",
        "@rootUrl" : "https://172.20.127.108/webacs/api/v2/op",
        "metricData" : [ {
          "XValueProperty" : {
            "label" : "String value",
            "unit" : "NUMBER"
          },
          "YValueProperty" : {
            "yvalueProperty" : [ {
              "label" : "String value",
              "maxVal" : 4.0,
              "minVal" : 4.0,
              "unit" : "NUMBER"
            }, {
              "label" : "Another string value",
              "maxVal" : 14.0,
              "minVal" : 14.0,
              "unit" : "STRING"
            } ]
          },
          "currentDateTime" : "String value",
          "description" : "String value",
          "metricName" : "String value",
          "metricRows" : {
            "metricRows" : [ {
              "XValue" : "String value",
              "YLabels" : {
                "ylabels" : [ "String value", "Another string value" ]
              },
              "YValues" : {
                "yvalues" : [ 15.0, 25.0 ]
              },
              "issue" : "String value"
            }, {
              "XValue" : "Another string value",
              "YLabels" : {
                "ylabels" : [ "String value", "Another string value" ]
              },
              "YValues" : {
                "yvalues" : [ 15.0, 25.0 ]
              },
              "issue" : "Another string value"
            } ]
          },
          "resourceName" : "String value"
        } ]
      }
    }

### Resource Information

Rate Limiting? | No
Sorting? | No
Paging? | No
Filtering? | No
Group Filtering? | No
Aggregation? | No
Response Formats | xml json
User Group | NBI Read
HTTP Methods | GET

## Resource URL

/webacs/api/v3/op/statisticsService/clusters/metrics/{metric}

Unmodified

This resource has not been modified since the previous API version.

## Request Parameters

Attribute | Source | Description
--- | --- | ---
metric String | path | Required The metric name for which the data need to be fetched
datacenter String | query | Optional Pattern to match the Datacenter name. If you do not specify any, all the Datacenters are considered.
cluster String | query | Optional Pattern to match the Cluster name. If you do not specify any, all the Clusters are considered.
timeInterval Integer | query | Required Specifies the timeInterval of time (in hours). This field can contain values like 1,2,4,8,16,24, 168(1week), 336(2Week), 720(1Month), 8760(1Year). Note: Either the timeInterval parameter or the parameters startTime and endTime are required. The timeInterval parameter overrides the startTime and endTime parameters.
startTime Long | query | Required Specifies the start time in seconds to check the interface utilization summary from. (See timeInterval for more details)
endTime Long | query | Required Specifies the end time in seconds to check the interface utilization summary to. (See timeInterval for more details)

## Response Parameters

Attribute | Description
--- | ---
currentDateTime String | Current timestamp
description String | Metric description
metricName String | Metric name
metricRows MetricRowDTO[] | Metric data list
Attribute | Description
--- | ---
issue String |
xValue String | X value
yLabels String[] | y label
yValues Double[] | Y value
resourceName String | Resource name
xValueProperty XValueProperty | Properties of X values
Attribute | Description
--- | ---
label String | Label for X
unit MetricUnitEnum | Unit for X Allowed values NUMBER STRING PERCENTAGE SECOND MILLISECOND BYTE KB MB BITS_PER_SECOND BYTES_PER_SECOND PACKETS FRAMES_PER_SECOND KB_PER_SEC HERTZ MEGAHERTZ DISC_UNIT NETWORK_UNIT DBM VOLT MICROSECOND MILLIAMP CELSIUS DECIBEL KBITS_PER_SEC BUFFER_UNDER_RUN_TIMES FAILURE_COUNT PS PS2 RAD_PER_SECOND DB RATIO ERROR_SECONDS CODE_VIOLATIONS BLOCK_ERRORS UNCORRECTABLE_WORDS BIT_ERRORS BLOCKS MA ERRORS BIT_ERRORS_RATE BIT BUFFER_OVERRUN_TIMES N_A PACKETS_PER_SECOND
yValueProperty YValueProperty[] | Properties of Y values
Attribute | Description
--- | ---
label String | Label for Y
maxVal double | Maximum of Y values
minVal double | Minimum of Y values
unit MetricUnitEnum | Unit for Y Allowed values NUMBER STRING PERCENTAGE SECOND MILLISECOND BYTE KB MB BITS_PER_SECOND BYTES_PER_SECOND PACKETS FRAMES_PER_SECOND KB_PER_SEC HERTZ MEGAHERTZ DISC_UNIT NETWORK_UNIT DBM VOLT MICROSECOND MILLIAMP CELSIUS DECIBEL KBITS_PER_SEC BUFFER_UNDER_RUN_TIMES FAILURE_COUNT PS PS2 RAD_PER_SECOND DB RATIO ERROR_SECONDS CODE_VIOLATIONS BLOCK_ERRORS UNCORRECTABLE_WORDS BIT_ERRORS BLOCKS MA ERRORS BIT_ERRORS_RATE BIT BUFFER_OVERRUN_TIMES N_A PACKETS_PER_SECOND

## Sample Payloads

Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.

### Sample XML Response Payload

https://172.20.127.108/webacs/api/v3/op/statisticsService/clusters/metrics/cpuUsage?datacenter="DC1"&cluster="CL1"&timeInterval=1

    <?xml version="1.0" ?>
    <mgmtResponse responseType="operation" requestUrl="https://172.20.127.108/webacs/api/v3/op/statisticsService/clusters/metrics/cpuUsage?datacenter=&amp;quot;DC1&amp;quot;&amp;amp;cluster=&amp;quot;CL1&amp;quot;&amp;amp;timeInterval=1
    					" rootUrl="https://172.20.127.108/webacs/api/v3/op">
      <metricData>
        <currentDateTime>String value</currentDateTime>
        <description>String value</description>
        <metricName>String value</metricName>
        <metricRows>
          <metricRows>
            <issue>String value</issue>
            <XValue>String value</XValue>
            <YLabels>
              <YLabels>String value</YLabels>
              <YLabels>Another string value</YLabels>
            </YLabels>
            <YValues>
              <YValues>15.0</YValues>
              <YValues>25.0</YValues>
            </YValues>
          </metricRows>
          <metricRows>
            <issue>Another string value</issue>
            <XValue>Another string value</XValue>
            <YLabels>
              <YLabels>String value</YLabels>
              <YLabels>Another string value</YLabels>
            </YLabels>
            <YValues>
              <YValues>15.0</YValues>
              <YValues>25.0</YValues>
            </YValues>
          </metricRows>
        </metricRows>
        <resourceName>String value</resourceName>
        <XValueProperty>
          <label>String value</label>
          <unit>NUMBER</unit>
        </XValueProperty>
        <YValueProperty>
          <YValueProperty>
            <label>String value</label>
            <maxVal>4.0</maxVal>
            <minVal>4.0</minVal>
            <unit>NUMBER</unit>
          </YValueProperty>
          <YValueProperty>
            <label>Another string value</label>
            <maxVal>14.0</maxVal>
            <minVal>14.0</minVal>
            <unit>STRING</unit>
          </YValueProperty>
        </YValueProperty>
      </metricData>
    </mgmtResponse>

### Sample JSON Response Payload

https://172.20.127.108/webacs/api/v3/op/statisticsService/clusters/metrics/cpuUsage.json?datacenter="DC1"&cluster="CL1"&timeInterval=1

    {
      "mgmtResponse" : {
        "@requestUrl" : "https://172.20.127.108/webacs/api/v3/op/statisticsService/clusters/metrics/cpuUsage?datacenter=&quot;DC1&quot;&amp;cluster=&quot;CL1&quot;&amp;timeInterval=1\n\t\t\t\t\t",
        "@responseType" : "operation",
        "@rootUrl" : "https://172.20.127.108/webacs/api/v3/op",
        "metricData" : [ {
          "XValueProperty" : {
            "label" : "String value",
            "unit" : "NUMBER"
          },
          "YValueProperty" : {
            "yvalueProperty" : [ {
              "label" : "String value",
              "maxVal" : 4.0,
              "minVal" : 4.0,
              "unit" : "NUMBER"
            }, {
              "label" : "Another string value",
              "maxVal" : 14.0,
              "minVal" : 14.0,
              "unit" : "STRING"
            } ]
          },
          "currentDateTime" : "String value",
          "description" : "String value",
          "metricName" : "String value",
          "metricRows" : {
            "metricRows" : [ {
              "XValue" : "String value",
              "YLabels" : {
                "ylabels" : [ "String value", "Another string value" ]
              },
              "YValues" : {
                "yvalues" : [ 15.0, 25.0 ]
              },
              "issue" : "String value"
            }, {
              "XValue" : "Another string value",
              "YLabels" : {
                "ylabels" : [ "String value", "Another string value" ]
              },
              "YValues" : {
                "yvalues" : [ 15.0, 25.0 ]
              },
              "issue" : "Another string value"
            } ]
          },
          "resourceName" : "String value"
        } ]
      }
    }

### Resource Information

Rate Limiting? | No
Sorting? | No
Paging? | No
Filtering? | No
Group Filtering? | No
Aggregation? | No
Response Formats | xml json
User Group | NBI Read
HTTP Methods | GET

## Resource URL

/webacs/api/v4/op/statisticsService/clusters/metrics/{metric}

Unmodified

This resource has not been modified since the previous API version.

## Request Parameters

Attribute | Source | Description
--- | --- | ---
metric String | path | Required The metric name for which the data need to be fetched
datacenter String | query | Optional Pattern to match the Datacenter name. If you do not specify any, all the Datacenters are considered.
cluster String | query | Optional Pattern to match the Cluster name. If you do not specify any, all the Clusters are considered.
timeInterval Integer | query | Required Specifies the timeInterval of time (in hours). This field can contain values like 1,2,4,8,16,24, 168(1week), 336(2Week), 720(1Month), 8760(1Year). Note: Either the timeInterval parameter or the parameters startTime and endTime are required. The timeInterval parameter overrides the startTime and endTime parameters.
startTime Long | query | Required Specifies the start time in seconds to check the interface utilization summary from. (See timeInterval for more details)
endTime Long | query | Required Specifies the end time in seconds to check the interface utilization summary to. (See timeInterval for more details)

## Response Parameters

Attribute | Description
--- | ---
currentDateTime String | Current timestamp
description String | Metric description
metricName String | Metric name
metricRows MetricRowDTO[] | Metric data list
Attribute | Description
--- | ---
issue String |
xValue String | X value
yLabels String[] | y label
yValues Double[] | Y value
resourceName String | Resource name
xValueProperty XValueProperty | Properties of X values
Attribute | Description
--- | ---
label String | Label for X
unit MetricUnitEnum | Unit for X Allowed values NUMBER STRING PERCENTAGE SECOND MILLISECOND BYTE KB MB BITS_PER_SECOND BYTES_PER_SECOND PACKETS FRAMES_PER_SECOND KB_PER_SEC HERTZ MEGAHERTZ DISC_UNIT NETWORK_UNIT DBM VOLT MICROSECOND MILLIAMP CELSIUS DECIBEL KBITS_PER_SEC BUFFER_UNDER_RUN_TIMES FAILURE_COUNT PS PS2 RAD_PER_SECOND DB RATIO ERROR_SECONDS CODE_VIOLATIONS BLOCK_ERRORS UNCORRECTABLE_WORDS BIT_ERRORS BLOCKS MA ERRORS BIT_ERRORS_RATE BIT BUFFER_OVERRUN_TIMES N_A PACKETS_PER_SECOND
yValueProperty YValueProperty[] | Properties of Y values
Attribute | Description
--- | ---
label String | Label for Y
maxVal double | Maximum of Y values
minVal double | Minimum of Y values
unit MetricUnitEnum | Unit for Y Allowed values NUMBER STRING PERCENTAGE SECOND MILLISECOND BYTE KB MB BITS_PER_SECOND BYTES_PER_SECOND PACKETS FRAMES_PER_SECOND KB_PER_SEC HERTZ MEGAHERTZ DISC_UNIT NETWORK_UNIT DBM VOLT MICROSECOND MILLIAMP CELSIUS DECIBEL KBITS_PER_SEC BUFFER_UNDER_RUN_TIMES FAILURE_COUNT PS PS2 RAD_PER_SECOND DB RATIO ERROR_SECONDS CODE_VIOLATIONS BLOCK_ERRORS UNCORRECTABLE_WORDS BIT_ERRORS BLOCKS MA ERRORS BIT_ERRORS_RATE BIT BUFFER_OVERRUN_TIMES N_A PACKETS_PER_SECOND

## Sample Payloads

Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.

### Sample XML Response Payload

https://172.20.127.108/webacs/api/v4/op/statisticsService/clusters/metrics/cpuUsage?datacenter="DC1"&cluster="CL1"&timeInterval=1

    <?xml version="1.0" ?>
    <mgmtResponse responseType="operation" requestUrl="https://172.20.127.108/webacs/api/v4/op/statisticsService/clusters/metrics/cpuUsage?datacenter=&amp;quot;DC1&amp;quot;&amp;amp;cluster=&amp;quot;CL1&amp;quot;&amp;amp;timeInterval=1
    					" rootUrl="https://172.20.127.108/webacs/api/v4/op">
      <metricData>
        <currentDateTime>String value</currentDateTime>
        <description>String value</description>
        <metricName>String value</metricName>
        <metricRows>
          <metricRows>
            <issue>String value</issue>
            <XValue>String value</XValue>
            <YLabels>
              <YLabels>String value</YLabels>
              <YLabels>Another string value</YLabels>
            </YLabels>
            <YValues>
              <YValues>15.0</YValues>
              <YValues>25.0</YValues>
            </YValues>
          </metricRows>
          <metricRows>
            <issue>Another string value</issue>
            <XValue>Another string value</XValue>
            <YLabels>
              <YLabels>String value</YLabels>
              <YLabels>Another string value</YLabels>
            </YLabels>
            <YValues>
              <YValues>15.0</YValues>
              <YValues>25.0</YValues>
            </YValues>
          </metricRows>
        </metricRows>
        <resourceName>String value</resourceName>
        <XValueProperty>
          <label>String value</label>
          <unit>NUMBER</unit>
        </XValueProperty>
        <YValueProperty>
          <YValueProperty>
            <label>String value</label>
            <maxVal>4.0</maxVal>
            <minVal>4.0</minVal>
            <unit>NUMBER</unit>
          </YValueProperty>
          <YValueProperty>
            <label>Another string value</label>
            <maxVal>14.0</maxVal>
            <minVal>14.0</minVal>
            <unit>STRING</unit>
          </YValueProperty>
        </YValueProperty>
      </metricData>
    </mgmtResponse>

### Sample JSON Response Payload

https://172.20.127.108/webacs/api/v4/op/statisticsService/clusters/metrics/cpuUsage.json?datacenter="DC1"&cluster="CL1"&timeInterval=1

    {
      "mgmtResponse" : {
        "@requestUrl" : "https://172.20.127.108/webacs/api/v4/op/statisticsService/clusters/metrics/cpuUsage?datacenter=&quot;DC1&quot;&amp;cluster=&quot;CL1&quot;&amp;timeInterval=1\n\t\t\t\t\t",
        "@responseType" : "operation",
        "@rootUrl" : "https://172.20.127.108/webacs/api/v4/op",
        "metricData" : [ {
          "XValueProperty" : {
            "label" : "String value",
            "unit" : "NUMBER"
          },
          "YValueProperty" : {
            "yvalueProperty" : [ {
              "label" : "String value",
              "maxVal" : 4.0,
              "minVal" : 4.0,
              "unit" : "NUMBER"
            }, {
              "label" : "Another string value",
              "maxVal" : 14.0,
              "minVal" : 14.0,
              "unit" : "STRING"
            } ]
          },
          "currentDateTime" : "String value",
          "description" : "String value",
          "metricName" : "String value",
          "metricRows" : {
            "metricRows" : [ {
              "XValue" : "String value",
              "YLabels" : {
                "ylabels" : [ "String value", "Another string value" ]
              },
              "YValues" : {
                "yvalues" : [ 15.0, 25.0 ]
              },
              "issue" : "String value"
            }, {
              "XValue" : "Another string value",
              "YLabels" : {
                "ylabels" : [ "String value", "Another string value" ]
              },
              "YValues" : {
                "yvalues" : [ 15.0, 25.0 ]
              },
              "issue" : "Another string value"
            } ]
          },
          "resourceName" : "String value"
        } ]
      }
    }