Navigation :

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

METHOD: GET
URI: /api/ or /api/list
Content-Type:
Content:

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.

Status: 200
Content-Type: text/json
Content: JSON Object

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.
`.availability`	Object	Container for application availability information. See: Application Configuration (Load-share and Failover) section.
`.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`	`SHUTDOWN` / `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.