Application List

Application List

This method returns a simple list of the applications currently executing within the n2svcd instance. This method is fast and lightweight, because the ManageApp does not communicate with the applications themselves. All information provided is taken from the startupg-configuration, or (when running in multi-process mode) from the IPC shared memory communications block.

HTTP Request

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.
multi 0/1 [Required] This this n2svcd install running in multi-process mode with shared-memory IPC communication?
shm_path String When running in multi-process mode, this is the path of the shared memory area.
Two n2svcd instancess running on the same platform must use different shared memory paths.
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.
.status 0-8 The availability status of this application. Refer to the list in the [Application Configuration](/config.html#handle-translation-and-application-status) section.
.status_name String The human-readable label corresponding to the status level. Refer to the list in the [Application Configuration](/config.html#handle-translation-and-application-status) section.