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

GET statisticsService/tdm/{section}/metrics

Fetches all metrics that are relevant for the TDM and Sonet port, as well as the URL of the next step ("TDM and Sonet Port Metric Data") that is available under the "url" element. Example: op/statisticsService/tdm/PATH/metrics?device=10.56.23.63&ifName=E1 0/3/0

Since Product Version: 2.0

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

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 URL

/webacs/api/v1/op/statisticsService/tdm/{section}/metrics

Request Parameters

Attribute Source Description

device String

query

Required

Defines the IP address of the device to which the TDM and SONET port belongs.

ifName String

query

Required

Defines the name of the interface on which the TDM and SONET statistics will be fetched

section String

path

Required

Specifies the section on which statistics are collected. Valid values are: LINE, PATH, CISCO-PATH, CISCO-SECTION, CISCO-LINE, VT-PATH.

timeInterval Integer

query

Optional

Fetches the data for the last specified number of hours. Applicable values are 1, 2, 4, 8, 16, 24, 168 (1 Week), 336 (2 Weeks), 720 (1 Month), 8760 (1Year). The timeInterval parameter overrides the startTime and endTime parameters. The default is 1 hour if neither the timeInterval nor the startTime and endTime parameters are provided.

startTime Long

query

Optional

Specifies the start time in milliseconds. The timeInterval parameter overrides this parameter.

endTime Long

query

Optional

Specifies the end time in milliseconds. The timeInterval parameter overrides this parameter.

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://10.64.88.203/webacs/api/v1/op/statisticsService/tdm/{section}/metrics

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://10.64.88.203/webacs/api/v1/op/statisticsService/tdm/{section}/metrics" rootUrl="https://10.64.88.203/webacs/api/v1/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://10.64.88.203/webacs/api/v1/op/statisticsService/tdm/{section}/metrics.json

{
  "mgmtResponse" : {
    "@responseType" : "operation",
    "@requestUrl" : "https : //10.64.88.203/webacs/api/v1/op/statisticsService/tdm/{
      section
    }/metrics",
    "@rootUrl" : "https : //10.64.88.203/webacs/api/v1/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"
        }]
      }
    }
  }
}