SoftLayer Network Bandwidth Version1 Allotment

From SoftLayer Development Network Wiki

Jump to: navigation, search

This page refers to the SoftLayer_Network_Bandwidth_Version1_Allotment service. For information on the SoftLayer_Network_Bandwidth_Version1_Allotment data type please see SoftLayer_Network_Bandwidth_Version1_Allotment (type).

Contents

Overview

Every SoftLayer Virtual Dedicated Rack(VDR), Virtual Datacenter, Virtual Private Rack(VPR) is defined in the SoftLayer_Network_Bandwidth_Version1_Allotment service as an allotment. SoftLayer allotments are a collection of servers that share all of the servers allocated bandwidth together.

Virtual Private Rack Each server is by default a part of your Virtual Private Rack. Bandwidth overages are billed individually per server for all hardware in your Virtual Private Rack. If any one server uses more bandwidth than it is allocated, an overage charge will result.

Virtual Dedicated Rack VDRs (Virtual Dedicated Rack) allow you to optimize your bandwidth usage by "pooling" all of the bandwidth together for servers in a VDR. Bandwidth overages for servers in a VDR are summed up as a whole and overages are calculated only if the total bandwidth of all servers exceeds the total allocated bandwidth for all servers.

For example, if you had 5 servers, each with 2000 GB of bandwidth, and one server used 3000 GB of bandwidth while the other used only 1500 GB of bandwidth, you would not be billed for an overage because your total usage would be 9000 GB and your total allocated would be 10000 GB.

Endpoints

SOAP WSDL http://api.service.softlayer.com/soap/v3/SoftLayer_Network_Bandwidth_Version1_Allotment?wsdl
XML-RPC http://api.service.softlayer.com/xmlrpc/v3/SoftLayer_Network_Bandwidth_Version1_Allotment

Methods

createObject

create a new allotment by passing in a allotment object.

  • returns
bool
  • parameters
SoftLayer_Network_Bandwidth_Version1_Allotment templateObject


deleteObject

delete the current allotment.

  • returns
bool
  • parameters
None


getAccount

Retrieve account associated with this VDR.

  • returns
SoftLayer_Account
  • parameters
None


getBackendBandwidthByHour

return a collection of private usage objects that contain hourly incoming and outgoing network traffic amounts for a 24 hour period.

  • returns
SoftLayer_Container_Network_Bandwidth_Version1_UsageArray
  • parameters
timestamp date


getBackendBandwidthUse

return a collection of private usage objects that contain hourly incoming and outgoing network traffic amounts for a customer date period.

  • returns
SoftLayer_Network_Bandwidth_Version1_Usage_DetailArray
  • parameters
timestamp startDate
timestamp endDate


getBandwidthImage

generate a graph image of all the bandwidth usage for an entire allotment of servers.

  • returns
SoftLayer_Container_Bandwidth_GraphOutputs
  • parameters
string networkType
string snapshotRange
bool draw
dateTime dateSpecified


getDetails

Retrieve the bandwidth allotment detail records associated with this VDR.

  • returns
SoftLayer_Network_Bandwidth_Version1_Allotment_DetailArray
  • parameters
None


getFrontendBandwidthByHour

return a collection of public usage objects that contain hourly incoming and outgoing network traffic amounts for a 24 hour period.

  • returns
SoftLayer_Container_Network_Bandwidth_Version1_UsageArray
  • parameters
timestamp date


getFrontendBandwidthUse

return a collection of public usage objects that contain hourly incoming and outgoing network traffic amounts for a 24 hour period.

  • returns
SoftLayer_Network_Bandwidth_Version1_Usage_DetailArray
  • parameters
timestamp startDate
timestamp endDate


getObject

Retrieve a SoftLayer_Network_Bandwidth_Version1_Allotment record.

  • returns
SoftLayer_Network_Bandwidth_Version1_Allotment
  • parameters
None


reassignServers

reassign a collection of servers to a different allotment.

  • returns
bool
  • parameters
SoftLayer_Hardware_Server[] templateObjects
int newAllotmentId


unassignServers

unassign a collection of servers from an allotment and insert them into the accounts VPR.

  • returns
bool
  • parameters
SoftLayer_Hardware_Server[] templateObjects
Retrieved from "http://sldn.softlayer.com/wiki/index.php/SoftLayer_Network_Bandwidth_Version1_Allotment"
Personal tools