Overview
Error Handling

Methods

API Documentation (API Version v1)

Monitoring/Load/

DESCRIPTION

This section contains methods for quering the load and usage statistics of a server.

graph

URL:

https://api.stormondemand.com/v1/Monitoring/Load/graph

Description:

Get a load graph for a server as a base64 encoded blob.

'stat' is the load statistic to be graphed. Available options are:

	'load1'      - 1 minute load average
	'load5'      - 5 minute load average
	'load15'     - 15 minute load average
	'rproc'      - running process count
	'tproc'      - total process count
	'pmem'       - physical memory usage
	'smem'       - swap (virtual) memory usage
	'diskroot'   - /root volume usage
	'diskbackup' - /backup volume usage
	'diskhome'   - /home volume usage
	'disktmp'    - /tmp volume usage
	'diskusr'    - /usr volume usage
	'diskvar'    - /var volume usage

'duration' is the duration of data you wish to graph. The default is to get the last day, but the following options are available:

	'6hour', '12hour', 'day', '3day', 'week', '2week'

Examples:

Perl:

   my $graph = $api->request('monitoring/load/graph',
                    { stat => 'load1', uniq_id => 'ABCD1234' });

   print "Content-type: $graph->{content_type}\n\n";
   print MIME::Base64::decode_base64($graph->{content});

Parameters:

ParameterTypeNotes
compactA boolean value (0 or 1).
durationA single word, consisting of only letters and digits.* Optional
  • Defaults to: day
heightA positive integer value (i.e. 1 and up).
statA single word, consisting of only letters and digits.* Required
uniq_idA six-character identifier, containing only capital letters and digits.* Required
widthA positive integer value (i.e. 1 and up).

Returns:

FieldType
contentA base64 string, consisting of letters, digits, +, /, possibly terminated by zero to two "=" characters
content_typeA MIME type, such as application/octet-stream, image/png, or text/plain

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

stats

URL:

https://api.stormondemand.com/v1/Monitoring/Load/stats

Description:

Get load stats for a server. Memory is returned in units of MB, whereas disk usage is in terms of GB. Values can be returned as 'N/A' if there was no data collected or the item in question is not something on the server.

Parameters:

ParameterTypeNotes
uniq_idA six-character identifier, containing only capital letters and digits.* Required

Returns:

FieldType
diskAn associative array containing the values:
 
percentA floating-point value.
totalA floating-point value.
usedA floating-point value.
domainA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
loadavgAn associative array containing the values:
 
fifteenA floating-point value.
fiveA floating-point value.
oneA floating-point value.
memoryAn associative array containing the values:
 
physicalAn associative array containing the values:
 
percentA floating-point value.
totalA floating-point value.
usedA floating-point value.
virtualAn associative array containing the values:
 
percentA floating-point value.
totalA floating-point value.
usedA floating-point value.
procAn associative array containing the values:
 
runningA non-negative integer value (i.e. 0 and up).
totalA non-negative integer value (i.e. 0 and up).
uptimeA string of text, containing no newlines or other control characters.

Possible Errors:

Refer to the Error Handling documentation for the list of exception types