Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

GET statisticsService/device/topNTemp

Resource Information

Rate Limiting?

Yes

Sorting?

No

Paging?

No

Filtering?

No

Response Formats

xml

json

User Group

NBI Read

HTTP Methods

GET

Retrieves the top N device temperature statistics.

Resource URL

/webacs/api/v1/op/statisticsService/device/topNTemp

Since : 1.2

Request Parameters

Type Attribute Name Source Description

Integer

range required

query

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

query

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

Long

endTime required

query

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

Integer

topN required

query

Indicates the number of top devices to get.

String

source optional

query

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

String

type required

query

Indicates the temperature unit. Possible values: FH, C.

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://szier-m8-106.cisco.com/webacs/api/v1/op/statisticsService/device/topNTemp?range=1&topN=5

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<mgmtResponse rootUrl="https://szier-m8-106.cisco.com/webacs/api/v1/op/" requestUrl="https://szier-m8-106.cisco.com/webacs/api/v1/op/statisticsService/device/topNTemp?range=1&amp;topN=5" 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://szier-m8-106.cisco.com/webacs/api/v1/op/statisticsService/device/topNTemp?range=1&topN=5.json

{
  "mgmtResponse" : {
    "@rootUrl" : "https : \/\/szier-m8-106.cisco.com\/webacs\/api\/v1\/op\/",
    "@requestUrl" : "https : \/\/szier-m8-106.cisco.com\/webacs\/api\/v1\/op\/statisticsService\/device\/topNTemp?range=1&topN=5",
    "@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"
    }
  }
}