Apache CloudStack 4.20.0.0 Root Admin API Reference

listEvents

A command to list events.

Request parameters

Parameter Name	Description	Required
account	list resources by account. Must be used with the domainId parameter.	false
archived	true to list archived events otherwise false	false
domainid	list only resources belonging to the domain specified	false
duration	the duration of the event	false
enddate	the 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
entrytime	the time the event was entered	false
id	the ID of the event	false
isrecursive	defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.	false
keyword	List by keyword	false
level	the event level (INFO, WARN, ERROR)	false
listall	If 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 false. Resources dedicated to a project are listed only if using the projectid parameter.	false
page		false
pagesize		false
projectid	list objects by project; if projectid=-1 lists All VMs	false
resourceid	the ID of the resource associated with the event	false
resourcetype	the type of the resource associated with the event	false
startdate	the 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
startid	the parent/start ID of the event, when provided this will list all the events with the start/parent ID including the parent event	false
type	the event type (see event types)	false

Response Tags

Response Name	Description
id	the ID of the event
account	the 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)
archived	whether the event has been archived or not
created	the date the event was created
description	a brief description of the event
domain	the name of the account's domain
domainid	the id of the account's domain
domainpath	path of the Domain the account's domain belongs to
level	the event level (INFO, WARN, ERROR)
parentid	whether the event is parented
project	the project name of the address
projectid	the project id of the ipaddress
resourceid	the id of the resource
resourcename	the name of the resource
resourcetype	the type of the resource
state	the state of the event
type	the type of the event (see event types)
username	the 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)

Copyright © 2015 The Apache Software Foundation, Licensed under the Apache License, Version 2.0.
Apache, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation.