Apache CloudStack 4.22.0.0 Root Admin API Reference

listSnapshotPolicies

Lists snapshot policies.

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
fordisplay	list resources by display flag; only ROOT admin is eligible to pass this parameter	false
id	the ID of the snapshot policy	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
page		false
pagesize		false
projectid	list objects by project; if projectid=-1 lists All VMs	false
volumeid	the ID of the disk volume	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
volumename	the name of the disk volume
zone	The list of zones in which snapshot backup is scheduled

Copyright © 2015 The Apache Software Foundation, Licensed under the Apache License, Version 2.0.
Apache, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation.