Integration Guides › Monitoring API Reference Guide › Monitoring API Protocol

Monitoring API Protocol

The protocol only uses the GET HTTP method, as it only provides reading functionality. Every supported type of protocol request can be defined by means of its URI and the output structure. Characters, that are considered special for the URI, should be escaped using the standard %-encoding.

We define the output by its XML schema. The primary output format is XML. Translation into other output formats, such as UDL and JSON, is achieved by direct usage of the respective output format's means of expressing structure and attributes. For example, UDL entities v.s. XML entities, UDL attributes v.s. XML attributes, JSON objects v.s. XML entities, JSON object properties v.s. XML attributes.

The root node of all outputs contains a timestamp attribute which provides the server time at the moment when the response was created.

The following is a description of all supported URL calls.

Counter Configuration Calls

/monapi/desc[?fmt=<format>] 

Returns a list of all available appliances in a specified output format. <format> is one of the known output formats, such as xml.

Output

<response timestamp="1194967464">
   <appliance name="main.web" />
   <appliance name="main.in" />
</response>

/monapi/desc/<apps>[?fmt=<format>] 

Returns a list of all available entities within the requested appliances (<apps>). <apps> might be a single appliance name, comma-separated list of appliance names, or a wildcard character (*) meaning all available appliances.

Output:

<response timestamp="1194967464">
   <appliance name="main.web">
      <entity name="Terminal in" />
      <entity name="Terminal out" />
      <entity name="Volume data" />
      <entity name="CPU" />
      <entity name="Memory" />
      <entity name="Network" />
   </appliance>
</response>

/monapi/desc/<apps>/<ents>[?fmt=<format>] 

Returns a list of all available counters within the requested appliance entities (<ents>). <ents> might be a single entity name, comma-separated list of entity names, or a wildcard character (*) meaning all available entities. This is also true for <apps>.

Output

<response timestamp="1194967464">
   <appliance name="main.web">
      <entity name="Terminal in">
         <counter name="Sent bytes" />
         <counter name="Received bytes" />
      </entity>
   </appliance>
</response>

/monapi/desc/<apps>/<ents>/<cnts>[?fmt=<format>] 

Returns the descriptions of requested counters (<cnts>). <ents>, <ents> and <ents> might be a single appliance/entity/counter, comma-separated list, or wildcard.

Output

<response timestamp="1194967464">
   <appliance name="main.web">
      <entity name="Terminal in">
         <counter name="Sent bytes" description=""  units=""  alarm_below="" alarm_above="" range_lower="" range_upper="" pace="" />
         <counter name="Received bytes" description=""  units=""  alarm_below="" alarm_above="" range_lower="" range_upper="" pace="" />
      </entity>
   </appliance>
</response>

Counter Value Calls

/monapi/val/<apps>/<ents>/<cnts>[?fmt=<format>] 

Returns the values of the specified counters. If any app, ent or cnt parameters are omitted, a wildcard value is assumed. For example, /monapi/val/main.web means "the values of all counters in all entities of appliance main.web".

Output

<response timestamp="1194967464">
   <appliance name="main.web">
      <entity name="Terminal in">
         <counter name="Sent bytes" value="23234" />
         <counter name="Received bytes" value="690432" />
      </entity>
   </appliance>
</response>