SoftLayer Hardware Server::getBandwidthByHour

From SoftLayer Development Network Wiki

getBandwidthByHour 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 Parameters 5.1 mode 5.2 day

Overview

Use this method to return all bandwidth updates on an hourly basis by hardware id. Since the potential number of data points is very large, the method limits you to returning data in 24 hour intervals. The day parameter needs to be a date and time. This will be used as the start point of your data query. The begin point will be calculated as 24 hours from that date/time. So to retrieve all the data for February 1st, 2008 from midnight through February 1st, 2008 23:59, pass in a day parameter of '02/01/2008 0:00'.

User Access

Users wishing to execute getBandwidthByHour service must have the View Hardware permission assigned to their account.

Return Type

getBandwidthByHour returns the SoftLayer_Container_Network_Bandwidth_Version1_UsageArray data type.

Headers

Required Headers

getBandwidthByHour requires the following headers:

• authenticate
• SoftLayer_Hardware_ServerInitParameters

Optional Headers

getBandwidthByHour may use the following headers:

• SoftLayer_Hardware_ServerObjectMask

Parameters

getBandwidthByHour takes the following parameters:

mode

Specifies the 'public' or 'private' port for this server.

• Type: string

---

day

A date and time formatted as 'MM/DD/YYYY HH:00'

• Type: dateTime