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
  • CustomWidget
  • create
  • update
  • delete
  • get
  • list
  • stat
  • Message
  • CreateCustomWidgetRequest
  • CustomWidgetInfo
  • CustomWidgetQuery
  • CustomWidgetRequest
  • CustomWidgetStatQuery
  • CustomWidgetsInfo
  • GetCustomWidgetRequest
  • UpdateCustomWidgetRequest
  1. content
  2. en
  3. dashboard
  4. v1

CustomWidget

description of dashboard

Package : spaceone.api.dashboard.v1

CustomWidget

CustomWidget Methods:

Method
Request
Response

create

POST /dashboard/v1/custom-widget/create

update

POST /dashboard/v1/custom-widget/update

delete

POST /dashboard/v1/custom-widget/delete

get

POST /dashboard/v1/custom-widget/get

list

POST /dashboard/v1/custom-widget/list

stat

POST /dashboard/v1/custom-widget/stat

Message

CreateCustomWidgetRequest

  • widget_name (string) Required

  • title (string) Required

  • options (Struct) Required

  • domain_id (string) Required

  • settings (Struct)

  • inherit_options (Struct)

  • labels (ListValue)

  • tags (Struct)

CustomWidgetInfo

  • custom_widget_id (string) Required

  • widget_name (string) Required

  • title (string) Required

  • version (string) Required

  • options (Struct) Required

  • settings (Struct) Required

  • inherit_options (Struct) Required

  • labels (ListValue) Required

  • tags (Struct) Required

  • user_id (string) Required

  • domain_id (string) Required

  • created_at (string) Required

  • updated_at (string) Required

CustomWidgetQuery

  • domain_id (string) Required

  • query (Query)

  • custom_widget_id (string)

  • widget_name (string)

  • title (string)

  • user_id (string)

CustomWidgetRequest

  • custom_widget_id (string) Required

  • domain_id (string) Required

CustomWidgetStatQuery

  • query (StatisticsQuery) Required

  • domain_id (string) Required

CustomWidgetsInfo

  • results (CustomWidgetInfo) Repeated Required

  • total_count (int32) Required

GetCustomWidgetRequest

  • custom_widget_id (string) Required

  • domain_id (string) Required

  • only (string) Repeated

UpdateCustomWidgetRequest

  • custom_widget_id (string) Required

  • domain_id (string) Required

  • title (string)

  • options (Struct)

  • settings (Struct)

  • inherit_options (Struct)

  • labels (ListValue)

  • tags (Struct)

Previousv1NextDashboard

Last updated 1 year ago

create
CreateCustomWidgetRequest
CustomWidgetInfo
update
UpdateCustomWidgetRequest
CustomWidgetInfo
delete
CustomWidgetRequest
Empty
get
GetCustomWidgetRequest
CustomWidgetInfo
list
CustomWidgetQuery
CustomWidgetsInfo
stat
CustomWidgetStatQuery
Struct