Hardware
SoftLayer_Hardware_Server::getPublicBandwidthGraphImage

Overview

Retrieve a graph of a server's public network bandwidth usage over the specified time frame. If no time frame is specified then getPublicBandwidthGraphImage retrieves the last 24 hours of public bandwidth usage. getPublicBandwidthGraphImage returns a PNG image measuring 827 pixels by 293 pixels. THIS METHOD GENERATES GRAPHS BASED ON THE NEW DATA WAREHOUSE REPOSITORY.

Parameters

startTime

dateTime

The starting point to retrieve bandwidth data from, specified as a date.

endTime

dateTime

The end point to retrieve bandwidth data to, specified as a date.

Headers

n/a
authenticate, SoftLayer_Hardware_ServerInitParameters

Return Values

binary data

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.