getPublicBandwidthData


SoftLayer_Hardware_SecurityModule::getPublicBandwidthData

Retrieve a graph of a server’s public network usage.

Overview

Retrieve a graph of a server’s public network bandwidth usage over the specified timeframe. If no timeframe is specified then getPublicBandwidthGraphImage retrieves the last 24 hours of public bandwidth usage. getPublicBandwidthGraphImage returns a PNG image measuring 827 pixels by 293 pixels.


Parameters

Name Type Description
startTime integer The starting point to retrieve bandwidth data from, specified as a [[dateTime
endTime integer The end point to retrieve bandwidth data to, specified as a [[dateTime

Required Headers

  • authenticate
  • SoftLayer_Hardware_SecurityModuleInitParameters

Return Values

Error Handling

  • SoftLayer_Exception

Throw the exception “Unable to retrieve the public bandwidth graph for server {id}.” if the API is unable to retrieve a valid PNG bandwidth graph image.

  • SoftLayer_Exception

Throw the exception “The start time {startTime} is not a readable date format.” if an invalid start time is passed to getPublicBandwidthGraphImage.

  • SoftLayer_Exception

Throw the exception “The end time {endTime} is not a readable date format.” if an invalid end time is passed to getPublicBandwidthGraphImage.