Apache CloudStack 4.20.0.0 Root Admin API Reference
archiveSnapshot
Archives (moves) a snapshot on primary storage to secondary storage
Request parameters
| Parameter Name | Description | Required |
| id | The ID of the snapshot | true |
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 |