collectBandwidth

Classes SoftLayer_Network_Storage_Iscsi
Tags method sldn network

SoftLayer_Network_Storage_Iscsi::collectBandwidth

Retrieve the bandwidth usage for the current billing cycle.

Description

{{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

Optional Headers

  • None

Return Values

  • unsignedLong

Error Handling

  • Throw the exception “The Storage type is not supported for bandwidth used collection. Please contact development.” 
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string, dateTime, dateTime]}' \
'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/collectBandwidth'