Generic management

The Apama REST API GET methods return information about correlators, IAFs, and the Dashboard Data Servers and Display Servers. The PUT /logLevel method changes the specified log level.

This method returns summary information about the component including its name, version, etc. This is analogous to the data that can be retrieved with the Apama engine_management tool, for example, the hostname field is exactly what engine_management --gethostname gives you.

Checks if the component is still running. If the component is running the client receives an empty response. A failure is a timeout waiting for the response.

This method displays the log level of a component.

This methods sets the log level of a component. For example, to set the log level of the correlator to DEBUG, use PUT http://localhost:15903/logLevel with the following XML document:

<?xml version="1.0"?>
<map name="apama-request">
<prop name="logLevel">DEBUG</prop>
</map>

Gets the incoming and outgoing messaging connections to the given component, along with the channels subscribed to and whether or not the receivers are slow. For Dashboard Data Servers and Display Servers, it shows the connected correlators as well as any configured named Dashboard Data Servers and Display Servers.

This method returns the arguments used when starting the component as a list of name-value pairs.

This method returns a list the environment variables in use as a list of name-value pairs.

Correlator only. This method returns information about whether the correlator is running with a license file, and if not, what restrictions are in place. See also Running Apama without a license file.

For the Dashboard Data Servers and Display Servers, this method returns the statistics of instance/trend table queries to Dashboard Data Servers and Display Servers.

For the correlator and IAF, this method provides access to the same information as the /correlator/status and /iaf/status URIs.

Dashboard Data Servers and Display Servers only. This method returns the names and values of the Java system properties of the component.

This method returns the names of the categories for which you can get general information.