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

GET apiHealth/callsPerClient

Returns the IP addresses of all clients using either all services or the specified service, over the last 24 hours.

Since Product Version: 2.2

Resource Information

Rate Limiting?

No

Sorting?

No

Paging?

No

Filtering?

No

Group Filtering?

No

Aggregation?

No

Response Formats

xml

json

User Group

NBI Read

HTTP Methods

GET

Resource URL

/webacs/api/v3/op/apiHealth/callsPerClient

Unmodified

This resource has not been modified since the previous API version.

Request Parameters

Attribute Source Description

service String

query

Optional

The service path. If unspecified, data will be returned for all services.

Response Parameters

Attribute Description

clientIp InetAddress

The client IP address.

requestCount long

The number of requests this client has made over the given period.

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.64.88.203/webacs/api/v3/op/apiHealth/callsPerClient?service=/api/v1/data/Alarms

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://10.64.88.203/webacs/api/v3/op/apiHealth/callsPerClient?service=/api/v1/data/Alarms" rootUrl="https://10.64.88.203/webacs/api/v3/op">
  <apiCallsPerClient>
    <clientIp>
      <address>192.168.115.243</address>
    </clientIp>
    <requestCount>2</requestCount>
  </apiCallsPerClient>
  <apiCallsPerClient>
    <clientIp>
      <address>192.168.115.244</address>
    </clientIp>
    <requestCount>12</requestCount>
  </apiCallsPerClient>
</mgmtResponse>

Sample JSON Response Payload

https://10.64.88.203/webacs/api/v3/op/apiHealth/callsPerClient.json?service=/api/v1/data/Alarms

{
  "mgmtResponse" : {
    "@requestUrl" : "https://10.64.88.203/webacs/api/v3/op/apiHealth/callsPerClient?service=/api/v1/data/Alarms",
    "@responseType" : "operation",
    "@rootUrl" : "https://10.64.88.203/webacs/api/v3/op",
    "apiCallsPerClient" : [ {
      "clientIp" : {
        "address" : "192.168.115.243"
      },
      "requestCount" : 2
    }, {
      "clientIp" : {
        "address" : "192.168.115.244"
      },
      "requestCount" : 12
    } ]
  }
}