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

GET statisticsService/device/availabilityMessage

Resource Information

Rate Limiting?

Yes

Sorting?

No

Paging?

No

Filtering?

No

Response Formats

xml

json

User Group

NBI Read

HTTP Methods

GET

Retrieves the device availability message.

Since Product Version: 1.2

Resource URL

/webacs/api/v1/op/statisticsService/device/availabilityMessage

Request Parameters

Type Attribute Name Source Description

String

ipAddress required

query

The IP Address of the device.

Response Parameters

Type Attribute Name Description

StatisticsDTO[]

childStatistics

The set of nested StatisticsDTO objects.

StatisticsEntry[]

statisticEntry

The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.

StatisticsOperationTypeEnum

statisticsName

The Statistics operation type.

Allowed values:

  • DEVICE_TOPN_CPU_UTILIZATION
  • DEVICE_TOPN_MEMORY_UTILIZATION
  • DEVICE_TOPN_TEMPERATURE
  • DEVICE_AVAILABILITY
  • DEVICE_AVAILABILITY_SUMMARY
  • DEVICE_CPU_UTILIZATION_TREND
  • DEVICE_MEMORY_UTILIZATION_TREND
  • DEVICE_HEALTH_INFO
  • DEVICE_REACHABILITY_STATUS
  • DEVICE_PORT_SUMMARY
  • DEVICE_AVAILABILITY_MESSAGE
  • DEVICE_DOWN_MESSAGE
  • DEVICE_CPU_UTILIZATION_SUMMARY
  • INTERFACE_AVAILABILITY
  • INTERFACE_DETAILS
  • INTERFACE_OUT_ERRORS
  • INTERFACE_DISCARDS
  • INTERFACE_UTILIZATION
  • INTERFACE_TOPN_UTILIZATION
  • INTERFACE_TOPN_ERRORS
  • INTERFACE_TOPN_WAN_UTILIZATION
  • INTERFACE_UTILIZATION_SUMMARY
  • INTERFACE_AVAILABILITY_SUMMARY
  • INTERFACE_STATUS_SUMMARY
  • INTERFACE_AVAILABILITY_MESSAGE
  • INTERFACE_DOWN_MESSAGE
  • INTERFACE_TOPN_WAN_ISSUES
  • INTERFACE_CLASSMAP_QOS
  • APPLICATION_TOPN_WORST_HOSTS
  • APPLICATION_TOPN_WORST_SITES
  • APPLICATION_TOPN_HOSTS
  • APPLICATION_TOPN_APP_PERFORMANCE
  • APPLICATION_TOPN_TRAFFIC_ANALYSIS
  • APPLICATION_NUMBER_OF_USERS
  • SYSTEM_INFO
  • SYSTEM_HEALTH
  • APPLICATION_VOLUME
  • APPLICATION_ART_ANALYSIS
  • APPLICATION_TOPN_TRAFFICS

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.25.123.114/webacs/api/v1/op/statisticsService/device/availabilityMessage?ipAddress="192.168.0.1"

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://172.25.123.114/webacs/api/v1/op/statisticsService/device/availabilityMessage?ipAddress=&amp;quot;192.168.0.1&amp;quot;" rootUrl="https://172.25.123.114/webacs/api/v1/op/">
  <statisticsDTO>
    <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>
  </statisticsDTO>
</mgmtResponse>

Sample JSON Response Payload

https://172.25.123.114/webacs/api/v1/op/statisticsService/device/availabilityMessage.json?ipAddress="192.168.0.1"

{
  "mgmtResponse" : {
    "@responseType" : "operation",
    "@requestUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/statisticsService\/device\/availabilityMessage?ipAddress=&quot;192.168.0.1&quot;",
    "@rootUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/",
    "statisticsDTO" : {
      "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"
    }
  }
}