Apache CloudStack 4.23.0.0 Root Admin API Reference
listBackupSchedule
List backup schedule of an Instance
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 | the ID of the backup schedule | 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 Instances | false |
| virtualmachineid | ID of the Instance | false |
Response Tags
| Response Name | Description |
| id | ID of the backup schedule. |
| intervaltype | The interval type of the backup schedule |
| isolated | Whether the backup will be isolated, defaults to false. Isolated backups are always created as full backups in independent chains. Therefore, they will never depend on any existing backup chain and no backup chain will depend on them. Currently only supported for the KBOSS provider. |
| maxbackups | maximum number of backups retained |
| quiescevm | quiesce the instance before checkpointing the disks for backup |
| schedule | The time the backup is scheduled to be taken. |
| timezone | The time zone of the backup schedule |
| virtualmachineid | ID of the Instance |
| virtualmachinename | Name of the Instance |