Cisco Prime Infrastructure API
Prime Infrastructure API Documentation
GET

GET statisticsService/device/availabilitySummary

Resource Information

Rate Limiting?

Yes

Sorting?

No

Paging?

No

Filtering?

No

Response Formats

xml

json

HTTP Methods

GET

Retrieves the device availability summary.

Resource URL

/webacs/api/v1/op/statisticsService/device/availabilitySummary

Request Parameters

Type Attribute Name Description

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.

Long

startTime required

Represents the start time of a time period in seconds. (See 'range' for more details)

Long

endTime required

Represents the end time of a time period in seconds. (See 'range' for more details)

String

source optional

An optional filter parameter that can be used to provide the IP Address or a group ID to get a filtered response.

String

rangeString optional

Specifies the pie chart range list. The responses use the provided ranges in the same order. An example format which is the default when not specified: 0-25,76-100,51-75,26-50.

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/device/availabilitySummary?range=1

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<mgmtResponse rootUrl="https://172.19.31.161/webacs/api/v1/op/statisticsService/device/statisticsService/device/availabilitySummary" requestUrl="https://172.19.31.161/webacs/api/v1/op/statisticsService/device/availabilitySummary?range=1" 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/device/availabilitySummary?range=1.json

{
  "mgmtResponse" : {
    "@rootUrl" : "https : \/\/172.19.31.161\/webacs\/api\/v1\/op\/statisticsService\/device\/statisticsService\/device\/availabilitySummary",
    "@requestUrl" : "https : \/\/172.19.31.161\/webacs\/api\/v1\/op\/statisticsService\/device\/availabilitySummary?range=1",
    "@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"
    }
  }
}