Apache CloudStack 4.23.0.0 Root Admin API Reference
updateBackupSchedule
Updates a User-defined Instance backup schedule
Request parameters
| Parameter Name | Description | Required |
| intervaltype | Valid values are HOURLY, DAILY, WEEKLY, and MONTHLY | true |
| schedule | Custom backup schedule, the format is:for HOURLY MM*, for DAILY MM:HH*, for WEEKLY MM:HH:DD (1-7)*, for MONTHLY MM:HH:DD (1-28) | true |
| timezone | Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format. | true |
| virtualmachineid | ID of the Instance for which schedule is to be defined | true |
| 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. | false |
| maxbackups | The maximum number of backups to keep for a VM. If "0", no retention policy will be applied and, thus, no backups from the schedule will be automatically deleted. This parameter is only supported for the Dummy, NAS and EMC Networker backup provider. | false |
| quiescevm | Quiesce the Instance before checkpointing the disks for backup. Applicable only to NAS and KBOSS backup providers. The filesystem is frozen before the backup starts and thawed immediately after. Requires the instance to have the QEMU Guest Agent installed and running. | false |
Response Tags
| Response Name | Description |
| id | ID of the Instance backup |
| account | Account name |
| accountid | Account id |
| backupofferingid | Backup offering id |
| backupofferingname | Backup offering name |
| compressionstatus | Backup compression status. |
| created | Backup date |
| description | description for the backup |
| domain | Domain name |
| domainid | Domain ID |
| externalid | External backup id |
| fromcheckpointid | Previous active checkpoint ID for incremental backups |
| hostid | Host ID where the backup is running |
| intervaltype | Interval type of the backup |
| isbackupvmexpunged | Indicates whether the VM from which the backup was taken is expunged or not |
| name | name of the backup |
| size | Backup size in bytes |
| status | Backup status |
| tocheckpointid | Next checkpoint ID for incremental backups |
| type | Backup type |
| uncompressedsize | Backup uncompressed size in bytes. Only defined if backup is compressed. |
| validationstatus | Backup validation status. |
| virtualmachineid | ID of the Instance |
| virtualmachinename | Name of the Instance |
| virtualsize | Backup protected (virtual) size in bytes |
| vmbackupofferingremoved | The backup offering corresponding to this backup was removed from the VM |
| vmdetails | Lists the vm specific details for the backup |
| volumes | Backed up volumes |
| zone | Zone name |
| zoneid | Zone ID |