Resource Drilldown

Resource Drilldown

The Application Summary method returns a list of the available Resource Vectors, and the number of rows in each Resource Vector.

The Resource Drilldown method is an API which provides the contents of an individual Resource Vector lists belonging to a specific application.

Internally, the ManageApp sends a !MANAGEMENT-RESOURCE-DRILLDOWN-REQUEST message to the application and wait for the corresponding !MANAGEMENT-RESOURCE-DRILLDOWN-RESPONSE message.

HTTP Request

Special characters in the or 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 resource 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.
app Object [Required] A condensed summary of the Application status.
.idx Integer [Required] The unique index number of this application.
.name Integer [Required] The unique name of this application.
.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.
columns Array of Object Descriptions of the columns in the resource vector being returned.
See columns attribute in !MANAGEMENT-CONFIGURATION-DRILLDOWN-RESPONSE internal message documentation.
list Array of Object One object for each entry in the resource vector table.
See list attribute in !MANAGEMENT-CONFIGURATION-DRILLDOWN-RESPONSE internal message documentation.

Note that the full value of extended columns is not included in the list results. Instead the returned value is a short summary of the content, e.g. “3044 Bytes” or “90 Rows”. To access the full value of an extended column you must use the Resource Drilldown Extended API method.