SoftLayer Hardware Server::getPublicBandwidthGraphImage

From SoftLayer Development Network Wiki

getPublicBandwidthGraphImage is a member of the SoftLayer_Hardware_Server service.

Contents 1 Overview 2 User Access 3 Return Type 4 Headers 4.1 Required Headers 5 Parameters 5.1 startTime 5.2 endTime 6 Error Handling 7 External Links

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.

User Access

Users wishing to execute getPublicBandwidthGraphImage must have the following permissions assigned to their account:

• View Hardware Details

Return Type

getPublicBandwidthGraphImage returns the base64Binary data type.

Headers

Required Headers

getPublicBandwidthGraphImage requires the following headers set:

• authenticate
• SoftLayer_Hardware_ServerInitParameter

Parameters

getPublicBandwidthGraphImage takes the following parameters:

startTime

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

• type: dateTime

---

endTime

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

• type: dateTime

Error Handling

getPublicBandwidthGraphImage throws the following exceptions:

• 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.

External Links

• Portable Network Graphics at Wikipedia