Apache CloudStack 4.22.0.0 Root Admin API Reference

listBackupSchedule

List backup schedule of a VM

Request parameters

Parameter NameDescriptionRequired
accountlist resources by account. Must be used with the domainId parameter.false
domainidlist only resources belonging to the domain specifiedfalse
idthe ID of the backup schedulefalse
isrecursivedefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
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 false. Resources dedicated to a project are listed only if using the projectid parameter.false
pagefalse
pagesizefalse
projectidlist objects by project; if projectid=-1 lists All VMsfalse
virtualmachineidID of the VMfalse

Response Tags

Response NameDescription
idID of the backup schedule.
intervaltypethe interval type of the backup schedule
maxbackupsmaximum number of backups retained
quiescevmquiesce the instance before checkpointing the disks for backup
scheduletime the backup is scheduled to be taken.
timezonethe time zone of the backup schedule
virtualmachineidID of the VM
virtualmachinenamename of the VM