Cisco Prime Infrastructure API
Prime Infrastructure 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

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

OptionalPattern to match the Datacenter name. If you do not specify any, all the Datacenters are considered.

timeInterval Integer

query

RequiredSpecifies 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

RequiredSpecifies the start time in seconds to check the interface utilization summary from. (See timeInterval for more details)

endTime Long

query

RequiredSpecifies 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 Arrow image MetricDetailsDTO[]

Metric details list

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://localhost/webacs/api/v3/op/statisticsService/datacenters/metrics?datacenter="DC1"&timeInterval=1

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v3/op/statisticsService/datacenters/metrics?datacenter=&amp;quot;DC1&amp;quot;&amp;amp;timeInterval=1
					" rootUrl="https://localhost/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>TOP_N</type>
        <units>
          <units>NUMBER</units>
          <units>STRING</units>
        </units>
        <url>Another string value</url>
      </metrics>
    </metrics>
  </metricsDTO>
</mgmtResponse>

Sample JSON Response Payload

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

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