Apache CloudStack 4.20.0.0 Root Admin API Reference
listSnapshots
Lists all available snapshots for the account.
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 |
| id | lists snapshot by snapshot ID | false |
| ids | the IDs of the snapshots, mutually exclusive with id | false |
| imagestoreid | ID of the image or image cache store | false |
| intervaltype | valid values are HOURLY, DAILY, WEEKLY, and MONTHLY. | 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 |
| locationtype | list snapshots by location type. Used only when showunique=false. Valid location types: 'primary', 'secondary'. Default is empty | false |
| name | lists snapshot by snapshot name | false |
| page | false | |
| pagesize | false | |
| projectid | list objects by project; if projectid=-1 lists All VMs | false |
| showunique | If set to false, list templates across zones and their storages | false |
| snapshottype | valid values are MANUAL or RECURRING. | false |
| storageid | ID of the storage pool | false |
| tags | List resources by tags (key/value pairs) | false |
| volumeid | the ID of the disk volume | false |
| zoneid | list snapshots by zone id | false |
Response Tags
| Response Name | Description |
| id | ID of the snapshot |
| account | the account associated with the snapshot |
| created | the date the snapshot was created |
| datastoreid | ID of the datastore for the snapshot entry |
| datastorename | name of the datastore for the snapshot entry |
| datastorestate | state of the snapshot on the datastore |
| datastoretype | type of the datastore for the snapshot entry |
| domain | the domain name of the snapshot's account |
| domainid | the domain ID of the snapshot's account |
| domainpath | path of the Domain the snapshot's account belongs to |
| downloaddetails | download progress of a snapshot |
| intervaltype | valid types are hourly, daily, weekly, monthy, template, and none. |
| locationtype | valid location types are primary and secondary. |
| name | name of the snapshot |
| osdisplayname | display name of the os on volume |
| ostypeid | id of the os on volume |
| physicalsize | physical size of backedup snapshot on image store |
| project | the project name of the snapshot |
| projectid | the project id of the snapshot |
| revertable | indicates whether the underlying storage supports reverting the volume to this snapshot |
| snapshottype | the type of the snapshot |
| state | the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage |
| status | the status of the template |
| virtualsize | virtual size of backedup snapshot on image store |
| volumeid | ID of the disk volume |
| volumename | name of the disk volume |
| volumestate | state of the disk volume |
| volumetype | type of the disk volume |
| zoneid | id of the availability zone |
| zonename | name of the availability zone |
| jobid | the ID of the latest async job acting on this object |
| jobstatus | the current status of the latest async job acting on this object |