SoftLayer Hardware Server::getPublicBandwidthDataSummary

From SoftLayer Development Network Wiki

getPublicBandwidthDataSummary is a member of the SoftLayer_Hardware_Server service.

Contents 1 Overview 2 User Access 3 Return Type 4 Headers 4.1 Required Headers 4.2 Optional Headers 5 Error Handling

Overview

Retrieve a brief summary of a server's public network bandwidth usage. getPublicBandwidthDataSummary 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.

User Access

Users wishing to execute getPublicBandwidthDataSummary must have the following permissions assigned to their account:

• View Hardware Details

Return Type

getPublicBandwidthDataSummary returns the SoftLayer_Container_Network_Bandwidth_Data_Summary data type.

Headers

Required Headers

getPublicBandwidthDataSummary requires the following headers set:

• authenticate
• SoftLayer_Hardware_ServerInitParameter

Optional Headers

getPublicBandwidthDataSummary takes the following optional headers:

• SoftLayer_Hardware_ServerObjectMask

Error Handling

getPublicBandwidthDataSummary throws the following exceptions:

• SoftLayer_Exception

Throw the exception "Unable to load the public bandwidth data summary for the server {id}." if the API is unable to retrieve a server's public bandwidth data.