1. REST API for Session Delivery Manager Release 9.0.1 and newer
  2. Tasks
  3. performance

Retrieve KPI Statistics for Devices

post

/{versionId}/performance/devices/kpis/stats

Retrieve KPI statistics for devices.

Request

Path Parameters
Back to Top

Response

200 Response

OK

400 Response

The user input is invalid.

401 Response

The session ID is invalid.

404 Response

The object (resource URI, device, and so on) of your input request cannot be found.
Back to Top

Examples

Examples of Accessing the API

See Authenticate for how to acquire a session cookie.

The following example shows how to retrieve KPI statistics for devices using curl.

curl -X POST \
    --header "Accept: application/xml" \
    --header "Authorization: Bearer $TOKEN" \
    "https://example.com:8443/{versionId}/performance/devices/kpis/stats"

The following example shows how to retrieve KPI statistics for devices using Python.

import requests
from lxml import etree
url = "https://example.com:8443/{versionId}/performance/devices/kpis/stats"
headers = { "Accept":"application/xml", "Content-Type: application/xml", "Cookie":cookie }
data = etree.tostring(etree.parse("request.json"))
resp = requests.post(url, headers=headers, data=data)

Example of the Request Body

The following example shows the contents of the request body in XML.

<?xml version="1.0" encoding="UTF-8"?>
<deviceKpiLists>
  <deviceIds>
      <deviceId>ID9</deviceId>
  </deviceIds>
  <kpiNames>
      <kpiNames>apSysCPUUtil</kpiNames>
      <kpiNames>apSysGlobalConSess</kpiNames>
      <kpiNames>apSysSipStatsActiveLocalContacts</kpiNames>
      <kpiNames>apSysLicenseCapacity</kpiNames>
      <kpiNames>apSysGlobalCPS</kpiNames>
      <kpiNames>apSysMemoryUtil</kpiNames>
      <kpiNames>apSysIsReachable</kpiNames>
      <kpiNames>apSysState</kpiNames>
   </kpiNames>
</deviceKpiLists>

The following example shows the contents of the request body in JSON.

{
  "deviceIds": {
      "deviceId": "ID1"
  },
  "kpiNames": [
      "apSysCPUUtil",
      "apSysGlobalConSess",
      "apSysSipStatsActiveLocalContacts",
      "apSysLicenseCapacity",
      "apSysGlobalCPS",
      "apSysMemoryUtil",
      "apSysIsReachable",
      "apSysState"
  ]
}

Example of the Response Body

The following example shows the contents of the response body in XML.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<deviceKpiStats>
  <deviceKpiStat>
    <kpis>
      <kpi>
          <lastUpdateTime>1665645740813</lastUpdateTime>
          <name>apSysCPUUtil</name>
          <value>0</value>
      </kpi>
      <kpi>
          <lastUpdateTime>1665645740813</lastUpdateTime>
          <name>apSysGlobalConSess</name>
          <value>0</value>
      </kpi>
      <kpi>
          <lastUpdateTime>1665645740813</lastUpdateTime>
          <name>apSysSipStatsActiveLocalContacts</name>
          <value>0</value>
      </kpi>
      <kpi>
          <lastUpdateTime>1665645740813</lastUpdateTime>
          <name>apSysLicenseCapacity</name>
          <value>0</value>
      </kpi>
      <kpi>
          <lastUpdateTime>1665645740813</lastUpdateTime>
          <name>apSysGlobalCPS</name>
          <value>0</value>
      </kpi>
      <kpi>
          <lastUpdateTime>1665645740813</lastUpdateTime>
          <name>apSysMemoryUtil</name>
          <value>10</value>
      </kpi>
    </kpis>
    <name>ID2</name>
  </deviceKpiStat>
</deviceKpiStats>

The following example shows the contents of the response body in JSON.

[{
  "kpis": {
     "kpi": [{
        "lastUpdateTime": "1664440859046",
        "name": "connectivityStatus",
        "value": "REACHABLE"
     }]
  },
  "name": "ID1"
}]
Back to Top