GET

Gets the value for a given serviceability attribute. Each piece of information is returned as an XML element named for each category of information.

Any combination of the categories listed below can be retrieved by providing any number of category parameters on the URL.

For example,

https://<ServerIP>:<Port>/ccp-webapp/ccp/serviceability?

category=diskUsage&category=serviceState

returns only the diskUsage and serviceStates categories.

Note

With no categories specified, all categories except systemInfo are returned. This is because systemInfo is very expensive to run as it collects all JMX attributes from all four JVMs in the product (runtime server, cassandra, solr and Tomcat).

To retrieve all categories including systemInfo, use the special all category: https://<ServerIP>:<Port>/ccp-webapp/ccp/serviceability?category=all

.

The parameter configtype can be used along with the category all or configuration to obtain the details of the specified configuration object along with other requested category details. Pass more than one configuration object to the configtype parameter by seperating the object names using a comma.

For example, the following api only returns feed configuration detail:

https://ServerIP:8080/ccp-webapp/ccp/serviceability?

category=configuration&configType=feed

Note

The parameter configtype must be used either with the category all or configuration. Specifying an invalid value for the configType parameter will generate an error.

URL:

https://<ServerIP>:<Port>/ccp-webapp/ccp/serviceability

HTTPS method:

GET

Parameters:

See Serviceability API Parameters.

Example XML response:

Example response for https://<ServerIP>:<Port>/ccp-webapp/ccp/serviceability/?category=serviceStates 


<serviceStates>
 <activemqServerState>
  SERVER_STATE_IN_SERVICE
 </activemqServerState>
	<datastoreServerState>
  SERVER_STATE_IN_SERVICE
 </datastoreServerState>
	<indexerServerState>
  SERVER_STATE_IN_SERVICE
 </indexerServerState>
	<runtimeServerState>
  SERVER_STATE_IN_SERVICE
 </runtimeServerState>
</serviceStates>