cloudforet-apis
  • README
  • content
    • en
      • Cloudforet API Documentation
      • board
        • _index
        • v1
          • Board
          • Post
          • v1
      • config
        • _index
        • v1
          • DomainConfig
          • PublicConfig
          • UserConfig
          • WorkspaceConfig
          • v1
      • core
        • _index
        • v1
          • Handler
          • Query
          • ServerInfo
          • v1
        • v2
          • Handler
          • Plugin
          • Query
          • v2
      • cost_analysis
        • _index
        • plugin
          • Cost
          • DataSource
          • Job
          • plugin
        • v1
          • Budget
          • BudgetUsage
          • Cost
          • CostQuerySet
          • CostReport
          • CostReportConfig
          • CostReportData
          • CustomWidget
          • DataSource
          • DataSourceAccount
          • DataSourceRule
          • ExchangeRate
          • Job
          • JobTask
          • PublicDashboard
          • Schedule
          • UnifiedCost
          • UserDashboard
          • v1
      • dashboard
        • _index
        • v1
          • CustomWidget
          • Dashboard
          • DomainDashboard
          • PrivateDashboard
          • PrivateDataTable
          • PrivateFolder
          • PrivateWidget
          • ProjectDashboard
          • PublicDashboard
          • PublicDataTable
          • PublicFolder
          • PublicWidget
          • v1
      • file_manager
        • _index
        • v1
          • File
          • PublicFile
          • v1
      • identity
        • _index
        • plugin
          • AccountCollector
          • Auth
          • ExternalAuth
          • plugin
        • v1
          • ApiKey
          • Authorization
          • Domain
          • DomainOwner
          • Endpoint
          • Policy
          • Project
          • ProjectGroup
          • Provider
          • Role
          • RoleBinding
          • ServiceAccount
          • Token
          • User
          • v1
        • v2
          • Agent
          • ApiKey
          • App
          • Authorization
          • Domain
          • Endpoint
          • ExternalAuth
          • Job
          • Package
          • Policy
          • Project
          • ProjectGroup
          • Provider
          • Role
          • RoleBinding
          • Schema
          • ServiceAccount
          • System
          • Token
          • TrustedAccount
          • TrustedServiceAccount
          • User
          • UserGroup
          • UserProfile
          • Workspace
          • WorkspaceGroup
          • WorkspaceGroupDetails
          • WorkspaceGroupUser
          • WorkspaceUser
          • v2
      • inventory
        • _index
        • plugin
          • Collector
          • Job
          • plugin
        • v1
          • ChangeHistory
          • CloudService
          • CloudServiceQuerySet
          • CloudServiceReport
          • CloudServiceStats
          • CloudServiceType
          • Collector
          • CollectorRule
          • Job
          • JobTask
          • Metric
          • MetricData
          • MetricExample
          • Namespace
          • Note
          • Region
          • ResourceGroup
          • v1
        • v2
          • Region
          • v2
      • monitoring
        • _index
        • plugin
          • DataSource
          • Event
          • Log
          • Metric
          • Webhook
          • plugin
        • v1
          • Alert
          • DataSource
          • EscalationPolicy
          • Event
          • EventRule
          • Log
          • MaintenanceWindow
          • Metric
          • Note
          • ProjectAlertConfig
          • Webhook
          • v1
      • mzc_service_api
        • _index
        • v1
          • Contract
          • Offering
          • Organization
          • v1
      • notification
        • _index
        • plugin
          • Notification
          • Protocol
          • plugin
        • v1
          • Notification
          • NotificationUsage
          • ProjectChannel
          • Protocol
          • Quota
          • UserChannel
          • v1
      • opsflow
        • _index
        • v1
          • Comment
          • Event
          • Task
          • TaskCategory
          • TaskType
          • v1
      • plugin
        • _index
        • v1
          • Plugin
          • Supervisor
          • v1
      • repository
        • _index
        • v1
          • DashboardTemplate
          • Plugin
          • Policy
          • Repository
          • Schema
          • v1
        • v2
          • Common
          • Provider
          • RemoteRepository
          • Schema
          • v2
      • sample
        • _index
        • v1
          • Helloworld
          • v1
      • search
        • _index
        • v1
          • Resource
          • v1
      • secret
        • _index
        • v1
          • Secret
          • SecretGroup
          • TrustedSecret
          • UserSecret
          • v1
      • statistics
        • _index
        • plugin
          • Storage
          • plugin
        • v1
          • History
          • Resource
          • Schedule
          • Storage
          • v1
Powered by GitBook
On this page
  • Schedule
  • add
  • update
  • enable
  • disable
  • delete
  • get
  • list
  • stat
  • Message
  • AddScheduleRequest
  • QueryOption
  • ScheduleInfo
  • ScheduleQuery
  • ScheduleRequest
  • ScheduleStatQuery
  • Scheduled
  • SchedulesInfo
  • UpdateScheduleRequest
  1. content
  2. en
  3. statistics
  4. v1

Schedule

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

Package : spaceone.api.statistics.v1

Schedule

Schedule Methods:

Method
Request
Response

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)

PreviousResourceNextStorage

Last updated 1 year ago

add
AddScheduleRequest
ScheduleInfo
update
UpdateScheduleRequest
ScheduleInfo
enable
ScheduleRequest
ScheduleInfo
disable
ScheduleRequest
ScheduleInfo
delete
ScheduleRequest
Empty
get
ScheduleRequest
ScheduleInfo
list
ScheduleQuery
SchedulesInfo
stat
ScheduleStatQuery
Struct