This example deals with a few ways of pulling data from SoftLayer_Event_Log. There can be quite a few Logs here, so using a filter it recommends like in the Get Recent Events to limit how far back your search for Events, otherwise you will be paging through Events for a long time.
To get all Events logs, We use SoftLayer_Event_Log::getAllObjects(), in this case just the first 50 events by using pagination as resultLimit=0,50, See Using Result Limits in the SoftLayer API. Also, We add a mask mask[eventName,eventCreateDate,userType] to restrict other local fields to limit the amount of information We get back to fields We care about at the moment.
https://api.softlayer.com/rest/v3.1/SoftLayer_Event_Log/getAllObjects.json?
resultLimit=0,50&
objectMask=mask[eventName,eventCreateDate,userType]
curl -g -u $SL_USER:$SL_APIKEY 'https://api.softlayer.com/rest/v3.1/SoftLayer_Event_Log/getAllObjects.json?objectMask=mask[eventName,eventCreateDate,userType]&resultLimit=0,50'
The output will look something like this,in this case just the first event in the list.
[
{
"eventCreateDate": "2021-03-29T14:41:55.444089-06:00",
"eventName": "Login Successful",
"userType": "CUSTOMER"
}
]
This query will get all the Recent Events that were created AFTER 03/29/2021 01:00:00 (this date is just an example so keep in mind updating the date example to retrieve the most recent events), object-filters has more details on other date time operations you can use.
https://api.softlayer.com/rest/v3.1/SoftLayer_Event_Log/getAllObjects.json?
resultLimit=0,50&
objectMask=mask[eventName,eventCreateDate,userType]&
objectFilter={"eventCreateDate":{"operation":"greaterThanDate","options":[{"name":"date","value":["2021-03-29T00:00:00.0000-06:00"]}]}}
curl -g -u $SL_USER:$SL_APIKEY 'https://api.softlayer.com/rest/v3.1/SoftLayer_Event_Log/getAllObjects.json?objectMask=mask[eventName,eventCreateDate,userType]&resultLimit=0,50&objectFilter={"eventCreateDate":{"operation":"greaterThanDate","options":[{"name":"date","value":["2021-03-01T00:00:00.0000-06:00"]}]}}'
Output example (first two events):
[
{
"eventCreateDate": "2021-03-26T14:22:26.349808-06:00",
"eventName": "Power On",
"userType": "SYSTEM"
},
{
"eventCreateDate": "2021-03-26T14:22:06.201563-06:00",
"eventName": "Power Off",
"userType": "SYSTEM"
}
]
To retrieve all event names We use SoftLayer_Event_Log::getAllEventObjectNames.
https://api.softlayer.com/rest/v3.1/SoftLayer_Event_Log/getAllEventObjectNames.json
curl -u $SL_USER:$SL_APIKEY 'https://api.softlayer.com/rest/v3.1/SoftLayer_Event_Log/getAllEventObjectNames.json'
Output:
['Bare Metal Instance',
'Server',
'API Authentication',
'Security Group',
'Account',
'CDN',
'User',
'CCI',
'Facility',
'Cloud Object Storage',
'Image',
'Storage',
'Bluemix LB']
To retrieve all user types We use SoftLayer_Event_Log::getAllUserTypes.
https://api.softlayer.com/rest/v3.1/SoftLayer_Event_Log/getAllUserTypes.json
curl -u $SL_USER:$SL_APIKEY 'https://api.softlayer.com/rest/v3.1/SoftLayer_Event_Log/getAllUserTypes.json'
Output:
['CUSTOMER', 'EMPLOYEE', 'SYSTEM']
To retrieve all the SYSTEM logs events.
https://api.softlayer.com/rest/v3.1/SoftLayer_Event_Log/getAllObjects.json?
resultLimit=0,50&
objectMask=mask[eventName,eventCreateDate,userType]&
objectFilter={"userType":{"operation":"SYSTEM"}}
curl -g -u $SL_USER:$SL_APIKEY 'https://api.softlayer.com/rest/v3.1/SoftLayer_Event_Log/getAllObjects.json?objectMask=mask[eventName,eventCreateDate,userType]&resultLimit=0,50&objectFilter={"userType":+{"operation":+"SYSTEM"}}'
Output example (first two events):
[
{
"eventCreateDate": "2021-03-19T14:10:28.976723-06:00",
"eventName": "Disable Port",
"userType": "SYSTEM"
},
{
"eventCreateDate": "2021-03-19T14:09:19.531900-06:00",
"eventName": "Cancel Service",
"userType": "SYSTEM"
}
]
https://api.softlayer.com/rest/v3.1/SoftLayer_Event_Log/getAllObjects.json?
resultLimit=0,50&
objectMask=mask[eventName,eventCreateDate,userType]&
objectFilter={"eventName":{"operation":"^= Login"}}
curl -g -u $SL_USER:$SL_APIKEY 'https://api.softlayer.com/rest/v3.1/SoftLayer_Event_Log/getAllObjects.json?objectMask=mask[eventName,eventCreateDate,userType]&resultLimit=0,50&objectFilter={"eventName":+{"operation":+"^=+Login"}}'
Output example (first two events):
[
{
"eventCreateDate": "2021-03-29T15:17:21.073746-06:00",
"eventName": "Login Successful",
"userType": "CUSTOMER"
},
{
"eventCreateDate": "2021-03-29T15:13:43.159343-06:00",
"eventName": "Login Successful",
"userType": "CUSTOMER"
}
]
If this article contains any error, or leaves any of your questions unanswered, please help us out by
opening up a github issue.
Open an issue