getBackendIncomingBandwidth

Classes SoftLayer_Hardware_Router
Tags method sldn hardware

SoftLayer_Hardware_Router::getBackendIncomingBandwidth

Retrieve the amount of incoming private network bandwidth used by a server over a period of time.

Description

The ‘‘‘getBackendIncomingBandwidth’’’ method retrieves the amount of incoming private network traffic used between the given start date and end date parameters. When entering start and end dates, only the month, day and year are used to calculate bandwidth totals - the time (HH:MM:SS) is ignored and defaults to midnight. The amount of bandwidth retrieved is measured in gigabytes.

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

  • “Please provide a start date.”
  • “Please provide an end date.” 
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}/getBackendIncomingBandwidth'