SoftLayer Hardware::getFrontendIncomingBandwidth

From SoftLayer Development Network Wiki

getFrontendIncomingBandwidth is a member of the SoftLayer_Hardware service.

Contents 1 Overview 2 Return Type 3 Headers 3.1 Required Headers 4 Parameters 4.1 startDate 4.2 endDate 5 Error Handling

Overview

Calculate the amount of incoming public network traffic used by a server between the given start time and end time parameters. Only the day, month, and year of the start and end dates are used for calculating bandwidth totals. Hour, minute, and second are ignored by this method and are set to midnight. The amount of bandwidth retrieved is measured in gigabytes.

Return Type

getFrontendIncomingBandwidth returns the float data type.

Headers

Required Headers

getFrontendIncomingBandwidth requires the following headers:

• authenticate
• SoftLayer_HardwareInitParameters

Parameters

getFrontendIncomingBandwidth takes the following parameters:

startDate

The start date for the range of bandwidth to retrieve.

• Type: dateTime

---

endDate

The end date for the range of bandwidth to retrieve.

• Type: dateTime

Error Handling

getFrontendIncomingBandwidth throws the following exceptions:

• SoftLayer_Exception_Public

Throw the exception "Please provide a start date." if no starting date parameter is given.

• SoftLayer_Exception_Public

Throw the exception "Please provide an end date." if no ending date parameter is given.