SoftLayer Network ContentDelivery Account
From SoftLayer Development Network Wiki
This page refers to the SoftLayer_Network_ContentDelivery_Account service. For information on the SoftLayer_Network_ContentDelivery_Account data type please see SoftLayer_Network_ContentDelivery_Account (type).
Overview
SoftLayer_Network_ContentDelivery_Account controls a single CDN user account and that account's content hosted on SoftLayer's CDN hosting infrastructure. Individual customer accounts can have more than one CDN account.
Every CDN account has the capability to configure and upload content to SoftLayer's CDN infrastructure. Once a file is uploaded it's replicated throughout CDN's worldwide nodes. When a user requests content from the CDN they retrieve data from the node in closest physical proximity to them, assuring failover in the case of single node failure and the lowest network latency possible.
CDN supports three distinct types of content, streaming Flash, streaming Windows Media and traditional HTTP. Each of these types of service are automatically set depending on the folder you upload your content to. Each of these types of content are accessed from different URLs:
| Content Type | Upload Directory | Access URL |
| Streaming Flash | /media/flash | rtmp://flash.cdnlayer.com/<your CDN account username>/ |
| Streaming Windows Media | /media/wm | mms://wm.cdnlayer.com/<your CDN account username>/ |
| HTTP content | /media/http | http://http.cdnlayer.com/<your CDN account username>/ |
CDN supports directory creation, bandwidth reporting, and an Origin Pull rule if you wish to manage your content directly on one of your servers. Files uploaded to CDN are accessed by users in directories relative to your account's root directory. For instance, if the file "/media/http/images/header.jpg" exists in your CDN space then it can be accessed at the URL "http://http.cdnlayer.com/<your CDN username>/images/header.jpg"
CDN accounts support FTP transfers in addition to API-based uploads. To access a CDN account's FTP space on the SoftLayer private network, log into ftp.cdnlayer.service.softlayer.com with an FTP client using your CDN account name and a password set either in the SoftLayer customer portal or by via the setFtpPassword method
CDN supports the content authentication service. CDN's content authentication service is the technology that allows only authorized user to access your content. It performs a token based authentication before delivering content. An authentication token can be obtained from the SoftLayer customer portal or API and it needs to be appended to the CDN URL. When an end-user requests a file, CDN server will check the validity of the token passed via HTTP GET string with a remote web service provided by SoftLayer. Then the content will be delivered if the value returned from the web service is good otherwise the connection will be rejected. The token authentication web service call is made in real time and it will hold the incoming connection until receiving a value returned from the website.
There are several scenarios where this authentication capability could be useful. Websites can prevent other rogue websites from linking to their videos. Content owners can prevent users from passing around HTTP links, thus forcing them to login to view contents. See SoftLayer_Network_ContentDelivery_Authentication_Token and SoftLayer_Network_ContentDelivery_Authentication_Address for more details on the content authentication service.
Endpoints
| SOAP WSDL | http://api.service.softlayer.com/soap/v3/SoftLayer_Network_ContentDelivery_Account?wsdl |
| XML-RPC | http://api.service.softlayer.com/xmlrpc/v3/SoftLayer_Network_ContentDelivery_Account |
Methods
authenticateResourceRequest
Validates an authentication token
- returns
- boolean
- parameters
createDirectory
Creates a directory on the CDN FTP server
- returns
- boolean
- parameters
- string directoryName
createFtpUser
Create a CDN FTP user record
- returns
- boolean
- parameters
- string newPassword
createOriginPullMapping
Sets up an Origin Pull domain rule
- returns
- boolean
- parameters
createOriginPullRule
Sets up an Origin Pull domain rule
- returns
- boolean
- parameters
- string originDomain
- string cnameRecord
deleteFtpUser
Deletes a CDN FTP user record
- returns
- boolean
- parameters
- None
deleteOriginPullRule
Removes an Origin Pull domain rule
- returns
- boolean
- parameters
- integer originMappingId
getAccount
Retrieve the customer account that a CDN account belongs to.
- returns
- parameters
- None
getAllPopsBandwidthData
Returns bandwidth data for each POP
- returns
- parameters
getAllPopsBandwidthImage
Returns an object with bandwidth graph data for each POP
- returns
- parameters
getAuthenticationIpAddresses
Retrieve the IP addresses that are used for the content authentication service.
- returns
- parameters
- None
getAuthenticationServiceEndpoints
Returns all token validation web service endpoints
- returns
- parameters
- None
getBandwidthData
Returns bandwidth data for a time range
- returns
- parameters
getBandwidthImage
Returns an object with bandwidth graph data
- returns
- parameters
getBillingItem
Retrieve the current billing item for a CDN account.
- returns
- parameters
- None
getCdnAccountName
Retrieve the name of a CDN account.
- returns
- string
- parameters
- None
getCdnSolutionName
Retrieve the solution type of a CDN account.
- returns
- string
- parameters
- None
getDirectoryInformation
Returns a directory list
- returns
- parameters
- string directoryName
getDiskSpaceUsageDataByDate
Returns a CDN FTP disk space usage
- returns
- parameters
getDiskSpaceUsageImageByDate
Returns an object with FTP disk usage graph data
- returns
- parameters
getFtpAttributes
Returns CDN FTP login credentials
- returns
- parameters
- None
getMediaUrls
Returns CDN supported URLs
- returns
- parameters
- None
getObject
Retrieve a SoftLayer_Network_ContentDelivery_Account record.
- returns
- parameters
- None
getOriginPullMappingInformation
Gets Origin Pull domain information
- returns
- parameters
- None
getOriginPullUrl
Gets Origin Pull domain information
- returns
- string
- parameters
- None
getPopNames
Returns all CDN POPs (Points of Presence).
- returns
- parameters
- None
getStatus
Retrieve a CDN account's status presented in a more detailed data type.
- returns
- parameters
- None
getVendorFtpAttrubutes
Returns login credentials to upload.cdnlayer.com FTP server
- returns
- parameters
- None
purgeCache
Purges content on POP
- returns
- parameters
- array of strings objectUrls
removeFile
Removes a file or a directory on the CDN FTP server
- returns
- boolean
- parameters
- string source
setAuthenticationServiceEndpoint
Sets the token validation web service endpoint
- returns
- boolean
- parameters
- string webserviceEndpoint
- string protocol
setFtpPassword
Updates a CDN FTP user password
- returns
- boolean
- parameters
- string newPassword
uploadStream
Uploads binary data to the CDN FTP server
- returns
- boolean
- parameters
- SoftLayer_Container_Utility_File_Attachment source
- string target

