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
  • Metric
  • list
  • get_data
  • Message
  • MetricDataInfo
  • MetricDataRequest
  • MetricInfo
  • MetricRequest
  • MetricsInfo
  1. content
  2. en
  3. monitoring
  4. plugin

Metric

A Metric is a monitoring metric data delivered from an external cloud service via a DataSource.

Package : spaceone.api.monitoring.plugin

Metric

Metric Methods:

Method
Request
Response

list

Gets a list of all Metrics from a specific cloud service. You can use the method to list up the Metrics to collect before using the get_data method to collect the Metrics.

get_data

Gets a Metric from a specific cloud service resource instance. By specifying the time period to collect the Metric, the Metric data value of the instance during the period is returned.

Message

MetricDataInfo

  • labels (ListValue) Required

  • values (Struct) Required

MetricDataRequest

  • options (Struct) Required

  • secret_data (Struct) Required

  • metric_query (Struct) Required

  • metric (string) Required

    metric identifier in case of requested metric info is not a single.

  • start (string) Required

  • end (string) Required

  • period (int32)

  • stat (string)

  • schema (string)

MetricInfo

  • key (string) Required

  • name (string) Required

  • group (string) Required

  • unit (Struct) Required

  • metric_query (Struct) Required

MetricRequest

  • options (Struct) Required

  • secret_data (Struct) Required

  • query (Struct) Required

  • schema (string)

MetricsInfo

  • metrics (MetricInfo) Repeated Required

PreviousLogNextWebhook

Last updated 1 year ago

list
MetricRequest
MetricsInfo
get_data
MetricDataRequest
MetricDataInfo