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

# GET statisticsService/datacenters/metrics

Deprecated

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

No metrics are available for Datacenters

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/datacenters/metrics

## Request Parameters

Attribute | Source | Description
--- | --- | ---
datacenter String | query | Optional Pattern to match the Datacenter name. If you do not specify any, all the Datacenters 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
--- | ---
info String | Metrics info
metrics MetricDetailsDTO[] | Metric details list
Attribute | Description
--- | ---
description String | Metric description
name String | Metric name
type MetricTypeEnum | Allowed values TIME_SERIES STATS TOP_N TABLE UID
units MetricUnitEnum[] | Units used in metric 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
url String | URL to fetch metric data

## 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/datacenters/metrics?datacenter="DC1"&timeInterval=1

    <?xml version="1.0" ?>
    <mgmtResponse responseType="operation" requestUrl="https://172.20.127.108/webacs/api/v2/op/statisticsService/datacenters/metrics?datacenter=&amp;quot;DC1&amp;quot;&amp;amp;timeInterval=1
    					" rootUrl="https://172.20.127.108/webacs/api/v2/op">
      <metricsDTO>
        <info>String value</info>
        <metrics>
          <metrics>
            <description>String value</description>
            <name>String value</name>
            <type>TIME_SERIES</type>
            <units>
              <units>NUMBER</units>
              <units>STRING</units>
            </units>
            <url>String value</url>
          </metrics>
          <metrics>
            <description>Another string value</description>
            <name>Another string value</name>
            <type>STATS</type>
            <units>
              <units>NUMBER</units>
              <units>STRING</units>
            </units>
            <url>Another string value</url>
          </metrics>
        </metrics>
      </metricsDTO>
    </mgmtResponse>

### Sample JSON Response Payload

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

    {
      "mgmtResponse" : {
        "@requestUrl" : "https://172.20.127.108/webacs/api/v2/op/statisticsService/datacenters/metrics?datacenter=&quot;DC1&quot;&amp;timeInterval=1\n\t\t\t\t\t",
        "@responseType" : "operation",
        "@rootUrl" : "https://172.20.127.108/webacs/api/v2/op",
        "metricsDTO" : [ {
          "info" : "String value",
          "metrics" : {
            "metrics" : [ {
              "description" : "String value",
              "name" : "String value",
              "type" : "TIME_SERIES",
              "units" : {
                "units" : [ "NUMBER", "STRING" ]
              },
              "url" : "String value"
            }, {
              "description" : "Another string value",
              "name" : "Another string value",
              "type" : "STATS",
              "units" : {
                "units" : [ "NUMBER", "STRING" ]
              },
              "url" : "Another 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/datacenters/metrics

Unmodified

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

## Request Parameters

Attribute | Source | Description
--- | --- | ---
datacenter String | query | Optional Pattern to match the Datacenter name. If you do not specify any, all the Datacenters 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
--- | ---
info String | Metrics info
metrics MetricDetailsDTO[] | Metric details list
Attribute | Description
--- | ---
description String | Metric description
name String | Metric name
type MetricTypeEnum | Allowed values TIME_SERIES STATS TOP_N TABLE UID
units MetricUnitEnum[] | Units used in metric 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
url String | URL to fetch metric data

## 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/datacenters/metrics?datacenter="DC1"&timeInterval=1

    <?xml version="1.0" ?>
    <mgmtResponse responseType="operation" requestUrl="https://172.20.127.108/webacs/api/v3/op/statisticsService/datacenters/metrics?datacenter=&amp;quot;DC1&amp;quot;&amp;amp;timeInterval=1
    					" rootUrl="https://172.20.127.108/webacs/api/v3/op">
      <metricsDTO>
        <info>String value</info>
        <metrics>
          <metrics>
            <description>String value</description>
            <name>String value</name>
            <type>TIME_SERIES</type>
            <units>
              <units>NUMBER</units>
              <units>STRING</units>
            </units>
            <url>String value</url>
          </metrics>
          <metrics>
            <description>Another string value</description>
            <name>Another string value</name>
            <type>STATS</type>
            <units>
              <units>NUMBER</units>
              <units>STRING</units>
            </units>
            <url>Another string value</url>
          </metrics>
        </metrics>
      </metricsDTO>
    </mgmtResponse>

### Sample JSON Response Payload

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

    {
      "mgmtResponse" : {
        "@requestUrl" : "https://172.20.127.108/webacs/api/v3/op/statisticsService/datacenters/metrics?datacenter=&quot;DC1&quot;&amp;timeInterval=1\n\t\t\t\t\t",
        "@responseType" : "operation",
        "@rootUrl" : "https://172.20.127.108/webacs/api/v3/op",
        "metricsDTO" : [ {
          "info" : "String value",
          "metrics" : {
            "metrics" : [ {
              "description" : "String value",
              "name" : "String value",
              "type" : "TIME_SERIES",
              "units" : {
                "units" : [ "NUMBER", "STRING" ]
              },
              "url" : "String value"
            }, {
              "description" : "Another string value",
              "name" : "Another string value",
              "type" : "STATS",
              "units" : {
                "units" : [ "NUMBER", "STRING" ]
              },
              "url" : "Another 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/datacenters/metrics

Unmodified

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

## Request Parameters

Attribute | Source | Description
--- | --- | ---
datacenter String | query | Optional Pattern to match the Datacenter name. If you do not specify any, all the Datacenters 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
--- | ---
info String | Metrics info
metrics MetricDetailsDTO[] | Metric details list
Attribute | Description
--- | ---
description String | Metric description
name String | Metric name
type MetricTypeEnum | Allowed values TIME_SERIES STATS TOP_N TABLE UID
units MetricUnitEnum[] | Units used in metric 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
url String | URL to fetch metric data

## 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/datacenters/metrics?datacenter="DC1"&timeInterval=1

    <?xml version="1.0" ?>
    <mgmtResponse responseType="operation" requestUrl="https://172.20.127.108/webacs/api/v4/op/statisticsService/datacenters/metrics?datacenter=&amp;quot;DC1&amp;quot;&amp;amp;timeInterval=1
    					" rootUrl="https://172.20.127.108/webacs/api/v4/op">
      <metricsDTO>
        <info>String value</info>
        <metrics>
          <metrics>
            <description>String value</description>
            <name>String value</name>
            <type>TIME_SERIES</type>
            <units>
              <units>NUMBER</units>
              <units>STRING</units>
            </units>
            <url>String value</url>
          </metrics>
          <metrics>
            <description>Another string value</description>
            <name>Another string value</name>
            <type>STATS</type>
            <units>
              <units>NUMBER</units>
              <units>STRING</units>
            </units>
            <url>Another string value</url>
          </metrics>
        </metrics>
      </metricsDTO>
    </mgmtResponse>

### Sample JSON Response Payload

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

    {
      "mgmtResponse" : {
        "@requestUrl" : "https://172.20.127.108/webacs/api/v4/op/statisticsService/datacenters/metrics?datacenter=&quot;DC1&quot;&amp;timeInterval=1\n\t\t\t\t\t",
        "@responseType" : "operation",
        "@rootUrl" : "https://172.20.127.108/webacs/api/v4/op",
        "metricsDTO" : [ {
          "info" : "String value",
          "metrics" : {
            "metrics" : [ {
              "description" : "String value",
              "name" : "String value",
              "type" : "TIME_SERIES",
              "units" : {
                "units" : [ "NUMBER", "STRING" ]
              },
              "url" : "String value"
            }, {
              "description" : "Another string value",
              "name" : "Another string value",
              "type" : "STATS",
              "units" : {
                "units" : [ "NUMBER", "STRING" ]
              },
              "url" : "Another string value"
            } ]
          }
        } ]
      }
    }