getBandwidthImage

Classes SoftLayer_Hardware_SecurityModule
Tags method sldn hardware

SoftLayer_Hardware_SecurityModule::getBandwidthImage

Retrieve a bandwidth image and textual description of that image for this server.

Description

Use this method when needing a bandwidth image for a single server. It will gather the correct input parameters for the generic graphing utility automatically based on the snapshot specified. Use the $draw flag to suppress the generation of the actual binary PNG image.

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
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_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getBandwidthImage'