Cisco Prime Infrastructure API
Prime Infrastructure API Documentation
GET

GET statisticsService/interface/util

Resource Information

Rate Limiting?

Yes

Sorting?

No

Paging?

No

Filtering?

No

Response Formats

xml

json

HTTP Methods

GET

Retrieves the interface utilization.

Resource URL

/webacs/api/v1/op/statisticsService/interface/util

Request Parameters

Type Attribute Name Description

Long

startTime required

Specifies the start time in seconds to check the interface utilization from. (See 'range' for more details)

Long

endTime required

Specifies the end time in seconds to check the interface utilization to. (See 'range' for more details)

Integer

range required

Specifies the range 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 range parameter or the parameters startTime and endTime are required. The range parameter overrides the startTime and endTime parameters.

String

ipAddress required

The IP address of the device to get the interface utilization from.

String

ifName required

The interface name to get utilization of.

String

type optional

An optional parameter that specifies the requested utilization type. Possible values: percent, octets. By default, when not specified it return octets information.

Response Parameters

A common response format is used across all statistics services of the Prime Infrastructure API. Please refer to the statistics response format section for details and samples.

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.194.172.75/webacs/api/v1/op/statisticsService/interface/util?range=1&ipAddress="192.168.0.1"&ifName="eth0"

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<mgmtResponse rootUrl="https://10.194.172.75/webacs/api/v1/op/statisticsService/interface/statisticsService/interface/util" requestUrl="https://10.194.172.75/webacs/api/v1/op/statisticsService/interface/util?range=1&amp;ipAddress=&quot;192.168.0.1&quot;&amp;ifName=&quot;eth0&quot;" responseType="operation">
    <statisticsDTO>
        <childStatistics>
            <childStatistic>
                <childStatistics>
                    <childStatistic>
                        <childStatistics>
                            <childStatistic>
                                <childStatistics>
                                    <childStatistic>
                                        <statisticEntries>
                                            <statisticEntry>
                                                <attributeName>String value</attributeName>
                                                <displayName>String value</displayName>
                                                <entryValue>String value</entryValue>
                                            </statisticEntry>
                                        </statisticEntries>
                                        <statisticsName>DEVICE_TOPN_CPU_UTILIZATION</statisticsName>
                                    </childStatistic>
                                </childStatistics>
                                <statisticEntries>
                                    <statisticEntry>
                                        <attributeName>String value</attributeName>
                                        <displayName>String value</displayName>
                                        <entryValue>String value</entryValue>
                                    </statisticEntry>
                                </statisticEntries>
                                <statisticsName>DEVICE_TOPN_CPU_UTILIZATION</statisticsName>
                            </childStatistic>
                        </childStatistics>
                        <statisticEntries>
                            <statisticEntry>
                                <attributeName>String value</attributeName>
                                <displayName>String value</displayName>
                                <entryValue>String value</entryValue>
                            </statisticEntry>
                        </statisticEntries>
                        <statisticsName>DEVICE_TOPN_CPU_UTILIZATION</statisticsName>
                    </childStatistic>
                </childStatistics>
                <statisticEntries>
                    <statisticEntry>
                        <attributeName>String value</attributeName>
                        <displayName>String value</displayName>
                        <entryValue>String value</entryValue>
                    </statisticEntry>
                </statisticEntries>
                <statisticsName>DEVICE_TOPN_CPU_UTILIZATION</statisticsName>
            </childStatistic>
        </childStatistics>
        <statisticsName>DEVICE_TOPN_CPU_UTILIZATION</statisticsName>
    </statisticsDTO>
</mgmtResponse>

Sample JSON Response Payload

https://10.194.172.75/webacs/api/v1/op/statisticsService/interface/util?range=1&ipAddress="192.168.0.1"&ifName="eth0".json

{
  "mgmtResponse" : {
    "@rootUrl" : "https : \/\/10.194.172.75\/webacs\/api\/v1\/op\/statisticsService\/interface\/statisticsService\/interface\/util",
    "@requestUrl" : "https : \/\/10.194.172.75\/webacs\/api\/v1\/op\/statisticsService\/interface\/util?range=1&ipAddress=\"192.168.0.1\"&ifName=\"eth0\"",
    "@responseType" : "operation",
    "statisticsDTO" : {
      "childStatistics" : {
        "childStatistic" : {
          "childStatistics" : {
            "childStatistic" : {
              "childStatistics" : {
                "childStatistic" : {
                  "childStatistics" : {
                    "childStatistic" : {
                      "statisticEntries" : {
                        "statisticEntry" : {
                          "attributeName" : "String value",
                          "displayName" : "String value",
                          "entryValue" : "String value"
                        }
                      },
                      "statisticsName" : "DEVICE_TOPN_CPU_UTILIZATION"
                    }
                  },
                  "statisticEntries" : {
                    "statisticEntry" : {
                      "attributeName" : "String value",
                      "displayName" : "String value",
                      "entryValue" : "String value"
                    }
                  },
                  "statisticsName" : "DEVICE_TOPN_CPU_UTILIZATION"
                }
              },
              "statisticEntries" : {
                "statisticEntry" : {
                  "attributeName" : "String value",
                  "displayName" : "String value",
                  "entryValue" : "String value"
                }
              },
              "statisticsName" : "DEVICE_TOPN_CPU_UTILIZATION"
            }
          },
          "statisticEntries" : {
            "statisticEntry" : {
              "attributeName" : "String value",
              "displayName" : "String value",
              "entryValue" : "String value"
            }
          },
          "statisticsName" : "DEVICE_TOPN_CPU_UTILIZATION"
        }
      },
      "statisticsName" : "DEVICE_TOPN_CPU_UTILIZATION"
    }
  }
}