Apache CloudStack 4.23.0.0 Root Admin API Reference

createResourceSchedule

Create Resource Schedule

Request parameters

Parameter NameDescriptionRequired
actionAction to take on the resource.true
resourceidID of the resource for which schedule is to be definedtrue
resourcetypeType of the resourcetrue
scheduleSchedule for action on resource in cron format. e.g. '0 15 10 * *' for 'at 15:00 on 10th day of every month'true
timezoneSpecifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.true
descriptionDescription of the schedulefalse
detailsMap of (key/value pairs) details for the schedule.false
enabledEnable schedule. Defaults to truefalse
enddateEnd date after which the schedule becomes inactive. (Format "yyyy-MM-dd hh:mm:ss")false
startdateStart date from which the schedule becomes active. Defaults to current date plus 1 minute. (Format "yyyy-MM-dd hh:mm:ss")false

Response Tags

Response NameDescription
idThe ID of resource schedule
actionAction
createdDate when the schedule was created
descriptionDescription of resource schedule
detailsSchedule details
enabledResource schedule is enabled
enddateDate after which the schedule becomes inactive
resourceidID of the resource
resourcetypeType of the resource
scheduleCron formatted resource schedule
startdateDate from which the schedule is active
timezoneTimezone of the schedule