Read operation

This operation allows administrators to read JMX counter values for Cisco Finesse Tomcat and Cisco Finesse Notification Service.

URI:

https://<FQDN>/finesse/api/performance

Example URI:

https://finesse1.xyz.com/finesse/api/performance

Security Constraints:

Administrators can use this API.

HTTP Method:

POST

Content Type:

Application/JSON

Input/Output Format:

JSON

HTTP Request:

Read Example for Cisco Finesse Tomcat:
Code Snippet
Copy
{
   "type" : "read",
    "mbean" : "com.cisco.ccbu:category=AWSSubsystem,component0=AWS Subsystem State Counter",
    "attribute" : "AWS System State"
}

HTTP Response:

200: Success

401: Unauthorized

403: Forbidden

500: Internal Server Error

Example Response:

Code Snippet
Copy
{
  "request": {
    "mbean": "com.cisco.ccbu:category=AWSSubsystem,component0=AWS Subsystem State Counter",
    "attribute": "AWS System State",
    "type": "read"
  },
  "value": "STATE_IN_SERVICE",
  "timestamp": 1667367062,
  "status": 200
}
Note

To read the JMX counter values of Cisco Finesse Notification Service, add the prefix "openfire//"(case-insensitive) before mbean name while making HTTP requests, as follows:

Code Snippet
Copy{
"type": "read",
"attribute": "HeapMemoryUsage",
"mbean": "openfire//java.lang:type=Memory"
}

JMX read operation is restricted for the limited types of JMX counters. The following table lists the Mbean names and corresponding attributes supported for each Mbean:

Mbean for Cisco Finesse Tomcat

Mbean

Attributes Supported

java.lang:type=Memory

HeapMemoryUsage, NonHeapMemoryUsage

java.lang:type=OperatingSystem

SystemLoadAverage

java.lang:type=Threading

ThreadCount, PeakThreadCount, DaemonThreadCount

java.lang:name=G1 Old Generation,type=GarbageCollector

*

java.lang:name=G1 Young Generation,type=GarbageCollector

*

Catalina:type=ThreadPool,name=*

*

com.cisco.ccbu:category=AWSSubsystem,*

*

com.cisco.ccbu:category=RuntimeConfigMBean,*

*

com.cisco.ccbu:category=TeamMessagesStats,*

*

com.cisco.ccbu:category=DRAPITasksStatsBean,*

*

com.cisco.ccbu:category=WebAppStats,*

*
Mbean for Cisco Finesse Notification Service

Mbean

Attributes Supported

java.lang:type=Memory

HeapMemoryUsage, NonHeapMemoryUsage

java.lang:type=OperatingSystem

SystemLoadAverage

java.lang:type=Threading

ThreadCount, PeakThreadCount, DaemonThreadCount

java.lang:name=G1 Old Generation,type=GarbageCollector

*

java.lang:name=G1 Young Generation,type=GarbageCollector

*

com.cisco.ccbu.finesse.openfire:type=PubSubOrderedExecutorStatistics

QueuedTaskCount

com.cisco.ccbu.finesse.openfire:type=Statistics

PacketStatistics
Note

The star (*) indicates all attributes listed for that Mbean.