Overview
Error Handling

Methods

API Documentation (API Version v1)

Monitoring/Bandwidth/

DESCRIPTION

This section of the api provides methods for querying in the bandwidth activity of a server.

graph

URL:

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

Description:

Get a bandwidth usage graph for a server. The image is returned as a base64 encoded blob.

'frequency' is the duration of the graph you wish to see. For example, if frequency is daily, the bandwidth usage for the last day would be graphed. The default is to get the last month, but the following options are available:

	'daily', 'weekly', 'monthly', 'yearly'

Examples:

Perl:

my $graph = $api->request('monitoring/bandwidth/graph', { uniq_id => ABC123 });

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

Parameters:

ParameterTypeNotes
frequencyA single word, consisting of only letters and digits.
heightA positive integer value (i.e. 1 and up).
smallA boolean value (0 or 1).
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/Bandwidth/stats

Description:

Get bandwidth usage stats for a server.

Parameters:

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

Returns:

FieldType
actualAn associative array containing the values:
 
bothAn associative array containing the values:
 
BA floating-point value.
GBA floating-point value.
KBA floating-point value.
MBA floating-point value.
inAn associative array containing the values:
 
BA floating-point value.
GBA floating-point value.
KBA floating-point value.
MBA floating-point value.
outAn associative array containing the values:
 
BA floating-point value.
GBA floating-point value.
KBA floating-point value.
MBA floating-point value.
averagesAn associative array containing the values:
 
dayAn associative array containing the values:
 
bothAn associative array containing the values:
 
BA floating-point value.
GBA floating-point value.
KBA floating-point value.
MBA floating-point value.
inAn associative array containing the values:
 
BA floating-point value.
GBA floating-point value.
KBA floating-point value.
MBA floating-point value.
outAn associative array containing the values:
 
BA floating-point value.
GBA floating-point value.
KBA floating-point value.
MBA floating-point value.
hourAn associative array containing the values:
 
bothAn associative array containing the values:
 
BA floating-point value.
GBA floating-point value.
KBA floating-point value.
MBA floating-point value.
inAn associative array containing the values:
 
BA floating-point value.
GBA floating-point value.
KBA floating-point value.
MBA floating-point value.
outAn associative array containing the values:
 
BA floating-point value.
GBA floating-point value.
KBA floating-point value.
MBA floating-point value.
minuteAn associative array containing the values:
 
bothAn associative array containing the values:
 
BA floating-point value.
GBA floating-point value.
KBA floating-point value.
MBA floating-point value.
inAn associative array containing the values:
 
BA floating-point value.
GBA floating-point value.
KBA floating-point value.
MBA floating-point value.
outAn associative array containing the values:
 
BA floating-point value.
GBA floating-point value.
KBA floating-point value.
MBA floating-point value.
monthAn associative array containing the values:
 
bothAn associative array containing the values:
 
BA floating-point value.
GBA floating-point value.
KBA floating-point value.
MBA floating-point value.
inAn associative array containing the values:
 
BA floating-point value.
GBA floating-point value.
KBA floating-point value.
MBA floating-point value.
outAn associative array containing the values:
 
BA floating-point value.
GBA floating-point value.
KBA floating-point value.
MBA floating-point value.
secondAn associative array containing the values:
 
bothAn associative array containing the values:
 
BA floating-point value.
GBA floating-point value.
KBA floating-point value.
MBA floating-point value.
inAn associative array containing the values:
 
BA floating-point value.
GBA floating-point value.
KBA floating-point value.
MBA floating-point value.
outAn associative array containing the values:
 
BA floating-point value.
GBA floating-point value.
KBA floating-point value.
MBA floating-point value.
weekAn associative array containing the values:
 
bothAn associative array containing the values:
 
BA floating-point value.
GBA floating-point value.
KBA floating-point value.
MBA floating-point value.
inAn associative array containing the values:
 
BA floating-point value.
GBA floating-point value.
KBA floating-point value.
MBA floating-point value.
outAn associative array containing the values:
 
BA floating-point value.
GBA floating-point value.
KBA floating-point value.
MBA floating-point value.
yearAn associative array containing the values:
 
bothAn associative array containing the values:
 
BA floating-point value.
GBA floating-point value.
KBA floating-point value.
MBA floating-point value.
inAn associative array containing the values:
 
BA floating-point value.
GBA floating-point value.
KBA floating-point value.
MBA floating-point value.
outAn associative array containing the values:
 
BA floating-point value.
GBA floating-point value.
KBA floating-point value.
MBA floating-point value.
costAn associative array containing the values:
 
currentA monetary value, such as -$.05, 0.05, or -5.00
projectedA monetary value, such as -$.05, 0.05, or -5.00
domainA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
pricingAn associative array containing the values:
 
per_gb_overA monetary value, such as -$.05, 0.05, or -5.00
priceA monetary value, such as -$.05, 0.05, or -5.00
quotaA non-negative integer value (i.e. 0 and up).
projectedAn associative array containing the values:
 
bothAn associative array containing the values:
 
BA floating-point value.
GBA floating-point value.
KBA floating-point value.
MBA floating-point value.
inAn associative array containing the values:
 
BA floating-point value.
GBA floating-point value.
KBA floating-point value.
MBA floating-point value.
outAn associative array containing the values:
 
BA floating-point value.
GBA floating-point value.
KBA floating-point value.
MBA floating-point value.

Possible Errors:

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