Apache CloudStack 4.18.0.0 Root Admin API Reference
listVMSnapshot
List virtual machine snapshot by conditions
Request parameters
| Parameter Name | Description | Required |
| account | list resources by account. Must be used with the domainId parameter. | false |
| domainid | list only resources belonging to the domain specified | 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 |
| 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 |
| name | lists snapshot by snapshot name or display name | false |
| page | false | |
| pagesize | false | |
| projectid | list objects by project; if projectid=-1 lists All VMs | false |
| state | state of the virtual machine snapshot | false |
| tags | List resources by tags (key/value pairs) | false |
| virtualmachineid | the ID of the vm | false |
| vmsnapshotid | The ID of the VM snapshot | false |
| vmsnapshotids | the IDs of the vm snapshots, mutually exclusive with vmsnapshotid | false |
Response Tags
| Response Name | Description |
| id | the ID of the vm snapshot |
| account | the account associated with the disk volume |
| created | the create date of the vm snapshot |
| current | indicates if this is current snapshot |
| description | the description of the vm snapshot |
| displayname | the display name of the vm snapshot |
| domain | the domain associated with the disk volume |
| domainid | the ID of the domain associated with the disk volume |
| hypervisor | the type of hypervisor on which snapshot is stored |
| name | the name of the vm snapshot |
| parent | the parent ID of the vm snapshot |
| parentName | the parent displayName of the vm snapshot |
| project | the project name of the vpn |
| projectid | the project id of the vpn |
| state | the state of the vm snapshot |
| type | VM Snapshot type |
| virtualmachineid | the vm ID of the vm snapshot |
| virtualmachinename | the vm name of the vm snapshot |
| zoneid | the Zone ID of the vm snapshot |
| zonename | the Zone name of the vm snapshot |