Apache CloudStack 4.18.0.0 Root Admin API Reference

listVMSnapshot

List virtual machine snapshot by conditions

Request parameters

Parameter NameDescriptionRequired
accountlist resources by account. Must be used with the domainId parameter.false
domainidlist only resources belonging to the domain specifiedfalse
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
namelists snapshot by snapshot name or display namefalse
pagefalse
pagesizefalse
projectidlist objects by project; if projectid=-1 lists All VMsfalse
statestate of the virtual machine snapshotfalse
tagsList resources by tags (key/value pairs)false
virtualmachineidthe ID of the vmfalse
vmsnapshotidThe ID of the VM snapshotfalse
vmsnapshotidsthe IDs of the vm snapshots, mutually exclusive with vmsnapshotidfalse

Response Tags

Response NameDescription
idthe ID of the vm snapshot
accountthe account associated with the disk volume
createdthe create date of the vm snapshot
currentindicates if this is current snapshot
descriptionthe description of the vm snapshot
displaynamethe display name of the vm snapshot
domainthe domain associated with the disk volume
domainidthe ID of the domain associated with the disk volume
hypervisorthe type of hypervisor on which snapshot is stored
namethe name of the vm snapshot
parentthe parent ID of the vm snapshot
parentNamethe parent displayName of the vm snapshot
projectthe project name of the vpn
projectidthe project id of the vpn
statethe state of the vm snapshot
typeVM Snapshot type
virtualmachineidthe vm ID of the vm snapshot
virtualmachinenamethe vm name of the vm snapshot
zoneidthe Zone ID of the vm snapshot
zonenamethe Zone name of the vm snapshot