SoftLayer Network Bandwidth Version1 Allotment::getBandwidthImage
From SoftLayer Development Network Wiki
getBandwidthImage is a member of the SoftLayer_Network_Bandwidth_Version1_Allotment service.
Contents |
Overview
This method recurses through all servers on a VDR 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. Depending on the current workload of the graphing server this method make take some time to return. As such, it is recommended the page not wait for the result without providing the user some sort of visual feedback. To facilitate this, an option to gather the parameters but not actually draw the image is included. This allows you to call the method twice, once for setting up your page, and then again to actually do the time consuming draw.
Return Type
getBandwidthImage returns the SoftLayer_Container_Bandwidth_GraphOutputs data type.
Headers
Required Headers
getBandwidthImage requires the following headers:
Parameters
getBandwidthImage takes the following parameters:
networkType
- public
- private
- Type: string
- Allowed values: public, private
snapshotRange
- day
- week
- 30day
- previous_calander_month
- current_calendar_month
- current_billing_cycle
- previous_billing_cycle
- specified_day
- Type: string
- Allowed values: day, week, 30day, previous_calander_month, current_calendar_month, current_billing_cycle, previous_billing_cycle, specified_day
draw
True, (default), if you wish to draw the image. Otherwise, you will get the return results minus the actual binary image data.
- Type: boolean
- Default Value:1
dateSpecified
Specify a date formatted as 'DD/MM/YYYY' if you passed a snapshot range of 'specified_day', (defaults to null).
- Type: dateTime
