getBandwidthImage

Classes SoftLayer_Network_Bandwidth_Version1_Allotment
Tags method sldn network

SoftLayer_Network_Bandwidth_Version1_Allotment::getBandwidthImage

generate a graph image of all the bandwidth usage for an entire allotment of servers.

Description

This method recurses through all servers on a Bandwidth Pool for a given snapshot range, gathers the necessary parameters, and then calls the bandwidth graphing server. The return result is a container that includes the min and max dates for all servers to be used in the query, as well as an image in PNG format. This method uses the new and improved drawing routines which should return in a reasonable time frame now that the new backend data warehouse is used.

Parameters

Name Type Description
networkType enum
  • public
  • private
snapshotRange enum
  • day
  • week
  • 30day
  • previous_calendar_month
  • current_calendar_month
  • current_billing_cycle
  • previous_billing_cycle
  • specified_day
  • specified_range
draw boolean TRUE to generate binary image otherwise just return text. Deprecated, images return fast enough now.
dateSpecified dateTime Include this parameter when snapshot is ‘specified_day’ or ‘specified_range’. Needs to be formatted as: ‘MM/DD/YYYY’
dateSpecifiedEnd dateTime Include this parameter when snapshotRange is ‘specified_range’. Also formatted as ‘MM/DD/YYYY’

Required Headers

Optional Headers

  • None

Return Values

curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [enum, enum, boolean, dateTime, dateTime]}' \
'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Bandwidth_Version1_Allotment/{SoftLayer_Network_Bandwidth_Version1_AllotmentID}/getBandwidthImage'