Cisco Prime Infrastructure API
Prime Infrastructure API Documentation
GET

GET statisticsService/interface/availMessage

Resource Information

Rate Limiting?

Yes

Sorting?

No

Paging?

No

Filtering?

No

Response Formats

xml

json

HTTP Methods

GET

Retrieves the interface availability message.

Resource URL

/webacs/api/v1/op/statisticsService/interface/availMessage

Request Parameters

Type Attribute Name Description

String

ipAddress required

The IP address of the device to check the interface available message of.

String

ifName required

The interface name to get the available message of.

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://172.19.31.161/webacs/api/v1/op/statisticsService/interface/availMessage?ipAddress="192.168.0.1"&ifName="eth0"

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<mgmtResponse rootUrl="https://172.19.31.161/webacs/api/v1/op/statisticsService/interface/statisticsService/interface/availMessage" requestUrl="https://172.19.31.161/webacs/api/v1/op/statisticsService/interface/availMessage?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://172.19.31.161/webacs/api/v1/op/statisticsService/interface/availMessage?ipAddress="192.168.0.1"&ifName="eth0".json

{
  "mgmtResponse" : {
    "@rootUrl" : "https : \/\/172.19.31.161\/webacs\/api\/v1\/op\/statisticsService\/interface\/statisticsService\/interface\/availMessage",
    "@requestUrl" : "https : \/\/172.19.31.161\/webacs\/api\/v1\/op\/statisticsService\/interface\/availMessage?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"
    }
  }
}