Apache CloudStack Root Admin API Reference


A command to list events.

Request parameters

Parameter NameDescriptionRequired
accountlist resources by account. Must be used with the domainId parameter.false
domainidlist only resources belonging to the domain specifiedfalse
durationthe duration of the eventfalse
enddatethe end date range of the list you want to retrieve (use format "yyyy-MM-dd" or the new format "yyyy-MM-dd HH:mm:ss")false
entrytimethe time the event was enteredfalse
idthe ID of the eventfalse
isrecursivedefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
levelthe event level (INFO, WARN, ERROR)false
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is falsefalse
projectidlist objects by projectfalse
startdatethe start date range of the list you want to retrieve (use format "yyyy-MM-dd" or the new format "yyyy-MM-dd HH:mm:ss")false
startidthe parent/start ID of the event, when provided this will list all the events with the start/parent ID including the parent eventfalse
typethe event type (see event types)false

Response Tags

Response NameDescription
idthe ID of the event
accountthe account name for the account that owns the object being acted on in the event (e.g. the owner of the virtual machine, ip address, or security group)
createdthe date the event was created
descriptiona brief description of the event
domainthe name of the account's domain
domainidthe id of the account's domain
levelthe event level (INFO, WARN, ERROR)
parentidwhether the event is parented
projectthe project name of the address
projectidthe project id of the ipaddress
statethe state of the event
typethe type of the event (see event types)
usernamethe name of the user who performed the action (can be different from the account if an admin is performing an action for a user, e.g. starting/stopping a user's virtual machine)