☰
Navigation :

Application Summary

Application Summary

This method returns a summary of the applications currently executing within the n2svcd instance. This interaction is slower than the simple Application List because the ManageApp needs to send a !MANAGEMENT-SUMMARY-REQUEST message to the application(s) and wait for the corresponding !MANAGEMENT-SUMMARY-RESPONSE message(s).

The caller can request that this be performed for all applications, or for a single named application.

HTTP Request

Special characters in the (such as :) must be URI percent-encoded.

HTTP Response

In failure, the response is a non-200 HTTP Status, with an optional text/plain Content describing the reason for failure.

In success, the HTTP Response content is a text/json representation of the system status and application list.

The JSON Object has the following structure:

Attribute Type Description
admin 0/1 [Required] Does this connection have access to update fields, and query protected fields.
config_file String [Required] The n2svcd.xml configuration file as specified at startup time.
ipc_description String [Required] Identifies the IPC mechanism being used for inter-process communication between applications.
For Shared Memory this string has the format "[SHM|<shm-path>]" e.g. "[SHM|/n2svcd].
For Sockets this is "[SOCKETS]" and for single-process this is "[SINGLE]".
identifier String Optional XML-configured parameter for the ManageApp application.
This parameter is potentially useful as a safety validation to identify test vs. production environments.
apps Array [Required] Array of applications running within this n2svcd instance.
idx Integer [Required] The unique index number of this application.
name Integer [Required] The unique name of this application.
pid Integer The process ID of this application.
Present only when running in multi-process mode.
admin_alloc Integer Size (bytes) of application's inbound administration (priority) IPC message buffer.
Present only when running in multi-process mode.
admin_used Integer Size (bytes) of as-yet-unread messages waiting in the administration IPC message buffer.
Present only when running in multi-process mode.
user_alloc Integer Size (bytes) of application's inbound user (non-priority) IPC message buffer.
Present only when running in multi-process mode.
user_used Integer Size (bytes) of as-yet-unread messages waiting in the user IPC message buffer.
Present only when running in multi-process mode.
availability Object Container for application availability information.
See: Application Configuration (Load-share and Failover) section.
When access == 0 (UNREACHABLE) then priority and loading fields are not present.
priority 0-3 The current, right-now priority for this application as an integer value.
priority_name DISASTER / FALLBACK / STANDBY / PRIMARY The corresponding human-readable priority name.
access 0-3 The current, right-now access for this application as an integer value.
This access value may have been clamped down, e.g. of the application has been toggled as Quiescing.
access_name UNREACHABLE / SHUTDOWN / STARTUP / OFFLINE / QUIESCING / ONLINE The corresponding human-readable access name.
load_pc 0-100 The current, right-now load on this application expressed as a percentage.
loading 0-3 The loading value as represented by the current alarm state for this application.
Note that when this value is set to 1 (HIGH) or 2 (OVERLOAD) then that value will be reported here for as long as the alarm is raised, which will be as long as the high/overload situation lasts plus some configurable number of seconds afterwards.
loading_name NORMAL / HIGH / OVERLOAD The corresponding human-readable access name.
shutdown_level 0/1/2 [Required] The application's current shutdown level 0 = None, 1 = Pending, 2 = Shutdown.
configuration Object Container for scalar and vector configuration values on this application.
See configuration attribute in !MANAGEMENT-SUMMARY-RESPONSE internal message documentation.
resource Array Container for scalar and vector resource values on this application.
See resource attribute in !MANAGEMENT-SUMMARY-RESPONSE internal message documentation.
statistics Array An Array of Objects representing current application Statistics counters.
See statistics attribute in !MANAGEMENT-SUMMARY-RESPONSE internal message documentation.
poll_stats Object A container for timing information regarding recent polling/work-loop timing.
See poll_stats attribute in !MANAGEMENT-SUMMARY-RESPONSE internal message documentation.