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
  • UnifiedCost
  • get
  • list
  • analyze
  • stat
  • Message
  • UnifiedCostAnalyzeQuery
  • UnifiedCostInfo
  • UnifiedCostQuery
  • UnifiedCostRequest
  • UnifiedCostStatQuery
  • UnifiedCostsInfo
  1. content
  2. en
  3. cost_analysis
  4. v1

UnifiedCost

PreviousScheduleNextUserDashboard

Last updated 7 months ago

Unified Cost service is a service that provides unified cost based on the cost data from various DataSources registered in each domain.

Package : spaceone.api.cost_analysis.v1

UnifiedCost

UnifiedCost Methods:

Method
Request
Response

get

POST /cost-analysis/v1/unified-cost/get

{{< tabs " get " >}}

{{< tab "Request Example" >}}

  • unified_cost_id (string) Required

{{< highlight json >}} { "unified_cost_id": "unified-cost-11153fceca11" } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

  • unified_cost_id (string) Required

  • cost (Struct) Required

  • billed_month (string) Required

    ex). 2021-01

  • billed_year (string) Required

    ex). 2021

  • aggregation_date (string) Required

    ex). 2021-01-01

  • exchange_date (string) Required

  • exchange_source (string) Required

    ex). Yahoo Finance

  • currency (string) Required

    Original currency of cost

  • is_confirmed (bool) Required

  • provider (string) Required

  • region_code (string) Required

  • region_key (string) Required

  • product (string) Required

  • usage_type (string) Required

  • usage_unit (string) Required

  • service_account_name (string) Required

  • data_source_name (string) Required

  • project_name (string) Required

  • workspace_name (string) Required

  • domain_id (string) Required

  • workspace_id (string) Required

  • project_id (string) Required

  • data_source_id (string) Required

  • service_account_id (string) Required

  • created_at (string) Required

{{< highlight json >}} { "unified_cost_id": "unified-cost-11153fceca11", "cost": { "KRW": 13000, "USD": 1, "JPY": 100 }, "billed_month": "2024-08", "billed_year": "2024", "exchange_date": "2024-08-14", "exchange_source": "Yahoo Finance!", "aggregation_date": "2024-08-15", "currency": "USD", "is_confirmed": true, "provider": "aws", "region_code": "AP2", "region_key": "aws.AP2", "product": "AmazonS3", "data_source_name": "AWS", "workspace_name": "SpaceONE", "data_source_id": "ds-1acca85666c1", "project_id": project-1acca85666c1, "workspace_id": "workspace-1acca85666c1", "domain_id": "domain-1acca85666c1", "created_at": "2024-09-30T08:00:03.945Z" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

list

POST /cost-analysis/v1/unified-cost/list

{{< tabs " list " >}}

{{< tab "Request Example" >}}

  • query (Query)

  • unified_cost_id (string)

{{< highlight json >}} { "query": {} } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

  • results (UnifiedCostInfo) Repeated Required

  • total_count (int32) Required

{{< highlight json >}} { "results": [ { "unified_cost_id": "unified-cost-11153fceca11", "cost": { "KRW": 13000, "USD": 1, "JPY": 100 }, "billed_month": "2024-08", "billed_year": "2024", "exchange_date": "2024-08-14", "exchange_source": "Yahoo Finance!", "aggregation_date": "2024-08-15", "currency": "USD", "is_confirmed": true, "provider": "aws", "region_code": "AP2", "region_key": "aws.AP2", "product": "AmazonS3", "data_source_name": "AWS", "workspace_name": "SpaceONE", "data_source_id": "ds-1acca85666c1", "project_id": project-1acca85666c1, "workspace_id": "workspace-1acca85666c1", "domain_id": "domain-1acca85666c1", "created_at": "2024-09-30T08:00:03.945Z" } ], "total_count": 1 } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

analyze

POST /cost-analysis/v1/unified-cost/analyze

{{< tabs " analyze " >}}

{{< tab "Request Example" >}}

  • query (TimeSeriesAnalyzeQuery) Required

  • is_confirmed (bool) Required

{{< highlight json >}} { "query": {} } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

stat

POST /cost-analysis/v1/unified-cost/stat

{{< tabs " stat " >}}

{{< tab "Request Example" >}}

  • query (StatisticsQuery) Required

{{< highlight json >}} { "query": {} } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

Message

UnifiedCostAnalyzeQuery

  • query (TimeSeriesAnalyzeQuery) Required

  • is_confirmed (bool) Required

UnifiedCostInfo

  • unified_cost_id (string) Required

  • cost (Struct) Required

  • billed_month (string) Required

    ex). 2021-01

  • billed_year (string) Required

    ex). 2021

  • aggregation_date (string) Required

    ex). 2021-01-01

  • exchange_date (string) Required

  • exchange_source (string) Required

    ex). Yahoo Finance

  • currency (string) Required

    Original currency of cost

  • is_confirmed (bool) Required

  • provider (string) Required

  • region_code (string) Required

  • region_key (string) Required

  • product (string) Required

  • usage_type (string) Required

  • usage_unit (string) Required

  • service_account_name (string) Required

  • data_source_name (string) Required

  • project_name (string) Required

  • workspace_name (string) Required

  • domain_id (string) Required

  • workspace_id (string) Required

  • project_id (string) Required

  • data_source_id (string) Required

  • service_account_id (string) Required

  • created_at (string) Required

UnifiedCostQuery

  • query (Query)

  • unified_cost_id (string)

UnifiedCostRequest

  • unified_cost_id (string) Required

UnifiedCostStatQuery

  • query (StatisticsQuery) Required

UnifiedCostsInfo

  • results (UnifiedCostInfo) Repeated Required

  • total_count (int32) Required

UnifiedCostRequest
UnifiedCostQuery
UnifiedCostAnalyzeQuery
UnifiedCostStatQuery
UnifiedCostInfo
UnifiedCostsInfo
get
UnifiedCostRequest
UnifiedCostInfo
list
UnifiedCostQuery
UnifiedCostsInfo
analyze
UnifiedCostAnalyzeQuery
Struct
stat
UnifiedCostStatQuery
Struct