SoftLayer Network ContentDelivery Account::getBandwidthData
From SoftLayer Development Network Wiki
getBandwidthData is a member of the SoftLayer_Network_ContentDelivery_Account service.
Contents |
Overview
This method returns bandwidth data for a given time range. It returns an array of bandwidth summary objects. Bandwidth summary object contains a beginning time, ending time, and bandwidth in bytes.
A Beginning and ending date parameters have to be a timestamp in "yyyy-mm-dd HH24:mi:ss" format and it assumes the time is in Central Standard Time (CST) or Central Daylight Time (CDT) time zone. CDN bandwidth data is stored in Greenwich Mean Time (GMT) internally and converts a beginning and ending time to GMT before querying.
Unlike SoftLayer server bandwidth, CDN bandwidth returns total bytes consumed within an hour. For example, if you pass "2008-10-10 00:00:00" for a beginning time and "2008-10-10 05:00:00" for an ending time, your return value will have 6 elements of bandwidth summary objects. The first bandwidth summary object will have the total bytes consumed between 2008-10-10 00:00:00 and 2008-10-10 00:59:59. And the last object will have the bandwidth consumed between 2008-10-10 05:00:00 and 2008-10-10 00:59:59. The bandwidth data is updated at 10 minutes after every hour. The queried data is on a two hour time delay. The two hour delay is required to gather bandwidth data from each POP and that is the minimum delay required to create a feasible graph. It usually takes about 8 hours to reconcile all the data from every CDN POP. This hourly data is corrected after 24 hours if necessary. If you consume a large amount of bandwidth, your bandwidth data will should be updated the next day. This data is used to determine your overage billing if you consumed more than 200 GB within the current billing cycle. CDN POP bandwidth is not associated with any billing process.
Return Type
getBandwidthData returns the SoftLayer_Container_Network_ContentDelivery_Bandwidth_SummaryArray data type.
Headers
Required Headers
getBandwidthData requires the following headers:
Optional Headers
getBandwidthData may use the following headers:
Parameters
getBandwidthData takes the following parameters:
beginDateTime
time
- Type: dateTime
endDateTime
time
- Type: dateTime
Error Handling
getBandwidthData throws the following exceptions:
- SoftLayer_Exception_Public
- Throws an exception if a user does not have CDN_BANDWIDTH_VIEW privilege.
- SoftLayer_Exception_Public
- Throws an exception if a beginning timestamp is invalid.
- SoftLayer_Exception_Public
- Throws an exception if a ending timestamp is invalid.
