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

Display Supported KPIs

get

/{versionId}/performance/devices/kpis

Display the supported KPIs for the platform and software version. This API supports query parameters.

Request

Path Parameters
Query 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 display the supported KPIs using curl.

curl -X GET \
    --header "Accept: application/xml" \
    --header "Authorization: Bearer $TOKEN" \
    "https://example.com:8443/rest/{versionId}/performance/devices/kpis?pluginKey=Oracle-SessionDelivery-AcmeSD&componentType=PEERING_SBC&platform=4500&softwareVersion=SCZ900"

The following example shows how to display the supported KPIs using Python.

import requests
from lxml import etree
url = "https://example.com:8443/rest/{versionId}/performance/devices/kpis?pluginKey=Oracle-SessionDelivery-AcmeSD&componentType=PEERING_SBC&platform=4500&softwareVersion=SCZ900"
headers = { "Accept":"application/xml", "Cookie":cookie }
resp = requests.get(url, headers=headers)

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"?>
<kpis>
  <kpi>
    <dataType>NumericalIncreasing</dataType>
    <description>CPU Utilization</description>
    <displayName>CPU Utilization</displayName>
    <name>apSysCPUUtil</name>
  </kpi>
  <kpi>
    <dataType>Boolean</dataType>
    <description>Is Reachable</description>
    <displayName>Is Reachable</displayName>
    <name>apSysIsReachable</name>
  </kpi>
  <kpi>
    <dataType>NumericalIncreasing</dataType>
    <description>Calls Per Second</description>
    <displayName>Calls Per Second</displayName>
    <name>apSysGlobalCPS</name>
  </kpi>
  <kpi>
    <dataType>String</dataType>
    <description>System State</description>
    <displayName>System State</displayName>
    <name>apSysState</name>
  </kpi>
  <kpi>
    <dataType>NumericalIncreasing</dataType>
    <description>Memory Utilization</description>
    <displayName>Memory Utilization</displayName>
    <name>apSysMemoryUtil</name>
  </kpi>
</kpis>

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

[
 {
  "dataType": "NumericalIncreasing",
  "description": "CPU Utilization",
  "displayName": "CPU Utilization",
  "name": "apSysCPUUtil"
 },{
  "dataType": "Boolean",
  "description": "Is Reachable",
  "displayName": "Is Reachable",
  "name": "apSysIsReachable"
 },{
  "dataType": "NumericalIncreasing",
  "description": "Calls Per Second",
  "displayName": "Calls Per Second",
  "name": "apSysGlobalCPS"
 },{
  "dataType": "String",
  "description": "System State",
  "displayName": "System State",
  "name": "apSysState"
 },{
  "dataType": "NumericalIncreasing",
  "description": "Memory Utilization",
  "displayName": "Memory Utilization",
  "name": "apSysMemoryUtil"
 }
]
Back to Top