SoftLayer Network Bandwidth Version1 Allotment::getBackendBandwidthByHour

From SoftLayer Development Network Wiki

getBackendBandwidthByHour is a member of the SoftLayer_Network_Bandwidth_Version1_Allotment service.

Contents 1 Overview 2 Return Type 3 Headers 3.1 Required Headers 3.2 Optional Headers 4 Parameters 4.1 date

Overview

This method recurses through all servers on a VDR for 24 hour time span starting at a given date/time. To get the private data set for all servers on a VDR from midnight Feb 1st, 2008 to 23:59 on Feb 1st, you would pass a parameter of '02/01/2008 0:00'. The ending date / time is calculated for you to prevent requesting data from the server for periods larger than 24 hours as this method requires processing a lot of data records and can get slow at times.

Return Type

getBackendBandwidthByHour returns the SoftLayer_Container_Network_Bandwidth_Version1_UsageArray data type.

Headers

Required Headers

getBackendBandwidthByHour requires the following headers:

• authenticate
• SoftLayer_Network_Bandwidth_Version1_AllotmentInitParameters

Optional Headers

getBackendBandwidthByHour may use the following headers:

• SoftLayer_Network_Bandwidth_Version1_AllotmentObjectMask

Parameters

getBackendBandwidthByHour takes the following parameters:

date

The date at which you wish to start a 24 hour snapshot formatted as 'MM/DD/YYYY HH:00'.

• Type: dateTime