SoftLayer Network TippingPointReporting::getMainStatistics
From SoftLayer Development Network Wiki
getMainStatistics is a member of the SoftLayer_Network_TippingPointReporting service.
Contents |
Overview
This method returns the attack statistics for the current user's account and for the entire SoftLayer network. These attacks are recorded and monitored at the entry point to the network, and represent attacks in both directions.
The data returned is:
- Top attacks (by attack name) on datacenter Dal01 in the last hour (and last 24 hours)
- Top attacks (by attack name) on IPs you own in the last hour (and last 24 hours)
- Top IPs attacking IPs you own in the last hour (and last 24 hours)
Each one of these lists can contain any number of items, the default is 5. The usable limit is less than 10, but setting the limit to an abnormally high value will effectively return all records.
The data is returned as a collection of SoftLayer_Container_Network_IntrusionProtection_Statistics objects.
User Access
Users wishing to execute getMainStatistics service must have the Network IDS permission assigned to their account.
Return Type
getMainStatistics returns the SoftLayer_Container_Network_IntrusionProtection_StatisticsArray data type.
Headers
Required Headers
getMainStatistics requires the following headers:
Optional Headers
getMainStatistics may use the following headers:
Parameters
getMainStatistics takes the following parameters:
numberOfAttacks
(optional) number of rows to show for each statistic. Default is 5
- Type: integer
- Default Value:5
Error Handling
getMainStatistics throws the following exceptions:
- SoftLayer_Exception_Public
- Throw the exception "Could not retrieve Account ID in SoftLayer_Network_TippingPointReporting getMainStatistics" if the current user's account ID could not be retrieved.
