getPrivateBandwidthDataSummary


SoftLayer_Hardware_Server::getPrivateBandwidthDataSummary

Retrieve a server’s private bandwidth usage summary

Description

Retrieve a brief summary of a server’s private network bandwidth usage. getPrivateBandwidthDataSummary retrieves a server’s bandwidth allocation for its billing period, its estimated usage during its billing period, and an estimation of how much bandwidth it will use during its billing period based on its current usage. A server’s projected bandwidth usage increases in accuracy as it progresses through its billing period.

Parameters

None

Required Headers

Optional Headers

  • None

Return Values

Error Handling

  • Throw the exception “Unable to load the private bandwidth data summary for the server {id}.” if the API is unable to retrieve a server’s public bandwidth data.
curl -g -u $SL_USER:$SL_APIKEY -X GET \
'https://api.softlayer.com/rest/v3.1/SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getPrivateBandwidthDataSummary'