collectBandwidth


SoftLayer_Network_Storage::collectBandwidth

Retrieve the bandwidth usage for the current billing cycle.

Overview

{{CloudLayerOnlyMethod}}

collectBandwidth() Retrieve the bandwidth usage for the current billing cycle.


Parameters

Name Type Description
type string The bandwidth type to collect usage for (upload, download)
startDate dateTime The starting date of the range of data you wish to collect.
endDate dateTime The ending date of the range of data you wish to collect.

Required Headers

  • authenticate
  • SoftLayer_Network_StorageInitParameters

Return Values

  • unsigned long

Error Handling

  • SoftLayer_Exception

Throw the exception “The Storage type is not supported for bandwidth used collection. Please contact development.”