Schedule

Schedule #

A Schedule is a time schedule of when a User will use a query.

Package : spaceone.api.statistics.v1



Schedule #

Schedule Methods:

MethodRequestResponse
addAddScheduleRequestScheduleInfo
updateUpdateScheduleRequestScheduleInfo
enableScheduleRequestScheduleInfo
disableScheduleRequestScheduleInfo
deleteScheduleRequestEmpty
getScheduleRequestScheduleInfo
listScheduleQuerySchedulesInfo
statScheduleStatQueryStruct

add #

Adds a new Schedule. When creating, topic and queries to be used should be specified. The time interval of the Schedule should be also specified to run queries repeatedly. The run set by Schedule starts every hour on the hour.

POST /statistics/v1/schedule/add


update #

Updates a specific Schedule. You can make changes in Schedule settings, including time intervals.

POST /statistics/schedule/update


enable #

Enables a specific Schedule. If a Schedule is enabled, the query usage will be scheduled by the time interval specified.

POST /statistics/v1/schedule/enable


disable #

Disables a specific Schedule. If a Schedule is disabled, the query usage will not be scheduled.

POST /statistics/v1/schedule/disable


delete #

Deletes a specific Schedule. You must specify the schedule_id of the Schedule to delete.

POST /statistics/v1/schedule/delete


get #

Gets a specific Schedule. Prints detailed information about the Schedule, including the schedule interval and state.

POST /statistics/v1/schedule/get


list #

Gets a list of all Schedules. You can use a query to get a filtered list of Schedules.

POST /statistics/v1/schedule/list


stat #

POST /statistics/v1/schedule/stat



Message #

AddScheduleRequest #

  • topic (string) Required

  • options (Struct) Required

  • schedule (Scheduled) Required

  • tags (Struct)


QueryOption #

  • aggregate (StatAggregate) Required

  • page (StatPage)


ScheduleInfo #

  • schedule_id (string) Required

  • topic (string) Required

  • state (State) Required

  • options (Struct) Required

  • schedule (Scheduled) Required

  • tags (Struct) Required

  • domain_id (string) Required

  • created_at (string) Required

  • last_scheduled_at (string) Required


ScheduleQuery #

  • query (Query)

  • schedule_id (string)

  • topic (string)

  • state (string)


ScheduleRequest #

  • schedule_id (string) Required


ScheduleStatQuery #

  • query (StatisticsQuery) Required


Scheduled #

  • cron (string) Required

  • interval (int32) Required

  • minutes (int32) Repeated Required

  • hours (int32) Repeated Required


SchedulesInfo #

  • results (ScheduleInfo) Repeated Required

  • total_count (int32) Required


UpdateScheduleRequest #

  • schedule_id (string) Required

  • schedule (Scheduled)

  • tags (Struct)


Calendar December 4, 2024
Edit Edit this page