getFrontendOutgoingBandwidth

Classes SoftLayer_Hardware_Router
Tags method sldn hardware

SoftLayer_Hardware_Router::getFrontendOutgoingBandwidth

Retrieve the amount of outgoing public network bandwidth used by a server over a period of time.

Description

The ‘‘‘getFrontendOutgoingBandwidth’’’ method retrieves the amount of outgoing public network traffic used by a server between the given start and end date parameters. The ‘‘dateTime’’ parameter requires only the day, month and year to be entered - the time (hour, minute and second) are set to midnight be default in order to gather the data for the entire start and end date indicated in the parameter. The amount of bandwidth retrieved is measured in gigabytes (GB).

Parameters

Name Type Description
startDate dateTime The start date for the range of bandwidth to retrieve.
endDate dateTime The end date for the range of bandwidth to retrieve.

Required Headers

Optional Headers

  • None

Return Values

  • float

Error Handling

  • Throw the exception “Please provide a start date.” if no starting date parameter is given.
  • Throw the exception “Please provide an end date.” if no ending date parameter is given. 
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [dateTime, dateTime]}' \
'https://api.softlayer.com/rest/v3.1/SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getFrontendOutgoingBandwidth'