Apache CloudStack 4.21.0.0 Root Admin API Reference
createSnapshotPolicy
Creates a snapshot policy for the account.
Request parameters
| Parameter Name | Description | Required |
| intervaltype | valid values are HOURLY, DAILY, WEEKLY, and MONTHLY | true |
| maxsnaps | maximum number of snapshots to retain | true |
| schedule | time the snapshot is scheduled to be taken. Format is:* if HOURLY, MM* if DAILY, MM:HH* if WEEKLY, MM:HH:DD (1-7)* if MONTHLY, MM:HH:DD (1-28) | true |
| timezone | Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format. | true |
| volumeid | the ID of the disk volume | true |
| fordisplay | an optional field, whether to the display the policy to the end user or not | false |
| storageids | A comma-separated list of IDs of the storage pools in other zones in which the snapshot will be made available. The snapshot will always be made available in the zone in which the volume is present. | false |
| tags | Map of tags (key/value pairs) | false |
| usestoragereplication | This parameter enables the option the snapshot to be copied to supported primary storage | false |
| zoneids | A list of IDs of the zones in which the snapshots will be made available.The snapshots will always be made available in the zone in which the volume is present. | false |
Response Tags
| Response Name | Description |
| id | the ID of the snapshot policy |
| fordisplay | is this policy for display to the regular user |
| intervaltype | the interval type of the snapshot policy |
| maxsnaps | maximum number of snapshots retained |
| schedule | time the snapshot is scheduled to be taken. |
| storage | The list of pools in which snapshot backup is scheduled |
| timezone | the time zone of the snapshot policy |
| volumeid | the ID of the disk volume |
| zone | The list of zones in which snapshot backup is scheduled |