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
  • create
  • update
  • delete
  • run
  • test
  • get
  • list
  • stat
  • Message
  • CreateMetricRequest
  • MetricInfo
  • MetricQuery
  • MetricRequest
  • MetricStatQuery
  • MetricTestRequest
  • MetricsInfo
  • UpdateMetricRequest
  1. content
  2. en
  3. inventory
  4. v1

Metric

Package : spaceone.api.inventory.v1

Metric

Metric Methods:

Method
Request
Response

create

POST /inventory/v1/metric/create

{{< tabs " create " >}}

{{< tab "Request Example" >}}

  • name (string) Required

  • metric_type (MetricType) Required

  • query_options (AnalyzeQuery) Required

  • namespace_id (string) Required

  • resource_group (ResourceGroup) Required

  • metric_id (string)

  • resource_type (string)

  • date_field (string)

  • unit (string)

  • tags (Struct)

  • workspace_id (string)

{{< highlight json >}} {

} {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

  • metric_id (string) Required

  • name (string) Required

  • metric_type (MetricType) Required

  • resource_type (string) Required

  • query_options (AnalyzeQuery) Required

  • date_field (string) Required

  • unit (string) Required

  • tags (Struct) Required

  • labels_info (Struct) Repeated Required

  • is_managed (bool) Required

  • resource_group (ResourceGroup) Required

  • domain_id (string) Required

  • workspace_id (string) Required

  • namespace_id (string) Required

  • created_at (string) Required

  • updated_at (string) Required

{{< highlight json >}} {

} {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

update

POST /inventory/v1/metric/update

{{< tabs " update " >}}

{{< tab "Request Example" >}}

  • metric_id (string) Required

  • name (string)

  • query_options (AnalyzeQuery)

  • date_field (string)

  • unit (string)

  • tags (Struct)

{{< highlight json >}} {

} {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

  • metric_id (string) Required

  • name (string) Required

  • metric_type (MetricType) Required

  • resource_type (string) Required

  • query_options (AnalyzeQuery) Required

  • date_field (string) Required

  • unit (string) Required

  • tags (Struct) Required

  • labels_info (Struct) Repeated Required

  • is_managed (bool) Required

  • resource_group (ResourceGroup) Required

  • domain_id (string) Required

  • workspace_id (string) Required

  • namespace_id (string) Required

  • created_at (string) Required

  • updated_at (string) Required

{{< highlight json >}} {

} {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

delete

POST /inventory/v1/metric/delete

{{< tabs " delete " >}}

{{< tab "Request Example" >}}

  • metric_id (string) Required

{{< highlight json >}} {

} {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

run

POST /inventory/v1/metric/run

{{< tabs " run " >}}

{{< tab "Request Example" >}}

  • metric_id (string) Required

{{< highlight json >}} {

} {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

test

POST /inventory/v1/metric/test

{{< tabs " test " >}}

{{< tab "Request Example" >}}

  • metric_id (string) Required

  • query_options (AnalyzeQuery) Required

{{< highlight json >}} {

} {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

get

POST /inventory/v1/metric/get

{{< tabs " get " >}}

{{< tab "Request Example" >}}

  • metric_id (string) Required

{{< highlight json >}} {

} {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

  • metric_id (string) Required

  • name (string) Required

  • metric_type (MetricType) Required

  • resource_type (string) Required

  • query_options (AnalyzeQuery) Required

  • date_field (string) Required

  • unit (string) Required

  • tags (Struct) Required

  • labels_info (Struct) Repeated Required

  • is_managed (bool) Required

  • resource_group (ResourceGroup) Required

  • domain_id (string) Required

  • workspace_id (string) Required

  • namespace_id (string) Required

  • created_at (string) Required

  • updated_at (string) Required

{{< highlight json >}} {

} {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

list

POST /inventory/v1/metric/list

{{< tabs " list " >}}

{{< tab "Request Example" >}}

  • query (Query)

  • metric_id (string)

  • metric_type (MetricType)

  • resource_type (string)

  • is_managed (string)

  • workspace_id (string)

  • namespace_id (string)

{{< highlight json >}} {

} {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

stat

POST /inventory/v1/metric/stat

Message

CreateMetricRequest

  • name (string) Required

  • metric_type (MetricType) Required

  • query_options (AnalyzeQuery) Required

  • namespace_id (string) Required

  • resource_group (ResourceGroup) Required

  • metric_id (string)

  • resource_type (string)

  • date_field (string)

  • unit (string)

  • tags (Struct)

  • workspace_id (string)

MetricInfo

  • metric_id (string) Required

  • name (string) Required

  • metric_type (MetricType) Required

  • resource_type (string) Required

  • query_options (AnalyzeQuery) Required

  • date_field (string) Required

  • unit (string) Required

  • tags (Struct) Required

  • labels_info (Struct) Repeated Required

  • is_managed (bool) Required

  • resource_group (ResourceGroup) Required

  • domain_id (string) Required

  • workspace_id (string) Required

  • namespace_id (string) Required

  • created_at (string) Required

  • updated_at (string) Required

MetricQuery

  • query (Query)

  • metric_id (string)

  • metric_type (MetricType)

  • resource_type (string)

  • is_managed (string)

  • workspace_id (string)

  • namespace_id (string)

MetricRequest

  • metric_id (string) Required

MetricStatQuery

  • query (StatisticsQuery) Required

MetricTestRequest

  • metric_id (string) Required

  • query_options (AnalyzeQuery) Required

MetricsInfo

  • results (MetricInfo) Repeated Required

  • total_count (int32) Required

UpdateMetricRequest

  • metric_id (string) Required

  • name (string)

  • query_options (AnalyzeQuery)

  • date_field (string)

  • unit (string)

  • tags (Struct)

PreviousJobTaskNextMetricData

Last updated 11 months ago

CreateMetricRequest
UpdateMetricRequest
MetricRequest
MetricRequest
MetricTestRequest
MetricRequest
MetricQuery
MetricInfo
MetricInfo
MetricInfo
create
CreateMetricRequest
MetricInfo
update
UpdateMetricRequest
MetricInfo
delete
MetricRequest
Empty
run
MetricRequest
Empty
test
MetricTestRequest
Struct
get
MetricRequest
MetricInfo
list
MetricQuery
MetricsInfo
stat
MetricStatQuery
Struct