Apache CloudStack 4.23.0.0 Root Admin API Reference
listVMSnapshot
List Instance 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 Instances | false |
| state | State of the Instance Snapshot | false |
| tags | List resources by tags (key/value pairs) | false |
| virtualmachineid | The ID of the Instance | false |
| vmsnapshotid | The ID of the Instance Snapshot | false |
| vmsnapshotids | The IDs of the Instance Snapshots, mutually exclusive with vmsnapshotid | false |
Response Tags
| Response Name | Description |
| id | The ID of the Instance Snapshot |
| account | The Account associated with the disk volume |
| created | The create date of the Instance Snapshot |
| current | Indicates if this is current Snapshot |
| description | The description of the Instance Snapshot |
| displayname | The display name of the Instance Snapshot |
| domain | The domain associated with the disk volume |
| domainid | The ID of the domain associated with the disk volume |
| domainpath | Path of the domain to which the disk volume belongs |
| hypervisor | The type of hypervisor on which Snapshot is stored |
| name | The name of the Instance Snapshot |
| parent | The parent ID of the Instance Snapshot |
| parentName | The parent displayName of the Instance Snapshot |
| project | The project name of the VPN |
| projectid | The project ID of the VPN |
| state | The state of the Instance Snapshot |
| type | Instance Snapshot type |
| virtualmachineid | The Instance ID of the Instance Snapshot |
| virtualmachinename | The Instance name of the Instance Snapshot |
| zoneid | The Zone ID of the Instance Snapshot |
| zonename | The Zone name of the Instance Snapshot |