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
  • CostQuerySet
  • create
  • update
  • delete
  • get
  • list
  • stat
  • Message
  • CostQuerySetInfo
  • CostQuerySetQuery
  • CostQuerySetRequest
  • CostQuerySetStatQuery
  • CostQuerySetsInfo
  • CreateCostQuerySetRequest
  • UpdateCostQuerySetRequest
  1. content
  2. en
  3. cost_analysis
  4. v1

CostQuerySet

A CostQuerySet is a set of saved queries a User frequently uses as a setting.

Package : spaceone.api.cost_analysis.v1

CostQuerySet

CostQuerySet Methods:

Method
Request
Response

create

Creates a new CostQuerySet. You can make your own custom query that meets your needs, and input it as an option parameter of the resource. Queries such as group_by and granularity are provided by default.

POST /cost-analysis/v1/cost-query-set/create

{{< tabs " create " >}}

{{< tab "Request Example" >}}

  • data_source_id (string) Required

  • name (string) Required

  • options (Struct) Required

  • tags (Struct)

{{< highlight json >}} { "data_source_id": "ds-085d1e872789", "name": "project_provider_region", "options": {} } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

  • cost_query_set_id (string) Required

  • name (string) Required

  • options (Struct) Required

  • tags (Struct) Required

  • domain_id (string) Required

  • workspace_id (string) Required

  • user_id (string) Required

  • data_source_id (string) Required

  • created_at (string) Required

  • updated_at (string) Required

{{< highlight json >}} { "cost_query_set_id": "query-76a58ea5d02c", "name": "project_provider_region", "options": {}, "tags": {}, "user_id": "test@cloudforet.io", "data_source_id": "ds-085d1e872789", "domain_id": "domain-58010aa2e451", "created_at": "2022-07-19T06:11:03.701Z", "updated_at": "2022-07-19T06:11:03.701Z" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

update

Updates a specific CostQuerySet. You can make changes in the details of queries.

POST /cost-analysis/v1/cost-query-set/update

{{< tabs " update " >}}

{{< tab "Request Example" >}}

  • cost_query_set_id (string) Required

  • name (string)

  • options (Struct)

  • tags (Struct)

{{< highlight json >}} { "cost_query_set_id": "query-76a58ea5d02c", "name": "project_provider_region", "options": {}, "tags": {}, "user_id": "test@cloudforet.io", "domain_id": "domain-58010aa2e451", "created_at": "2022-07-19T06:11:03.701Z", "updated_at": "2022-07-19T06:11:03.701Z" } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

  • cost_query_set_id (string) Required

  • name (string) Required

  • options (Struct) Required

  • tags (Struct) Required

  • domain_id (string) Required

  • workspace_id (string) Required

  • user_id (string) Required

  • data_source_id (string) Required

  • created_at (string) Required

  • updated_at (string) Required

{{< highlight json >}} { "cost_query_set_id": "query-76a58ea5d02c", "name": "project_provider_region", "options": {}, "tags": {}, "user_id": "test@cloudforet.io", "data_source_id": "ds-085d1e872789", "domain_id": "domain-58010aa2e451", "created_at": "2022-07-19T06:11:03.701Z", "updated_at": "2022-07-19T06:11:03.701Z" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

delete

Deletes a specific CostQuerySet. You must specify the cost_query_set_id of the CostQuerySet to delete.

POST /cost-analysis/v1/cost-query-set/delete

{{< tabs " delete " >}}

{{< tab "Request Example" >}}

  • cost_query_set_id (string) Required

{{< highlight json >}} { "cost_query_set_id": "query-16ae671dc8fb", "domain_id": "domain-58010aa2e451" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

get

Gets a specific CostQuerySet. Prints detailed information about the CostQuerySet, including the details of queries.

POST /cost-analysis/v1/cost-query-set/get

{{< tabs " get " >}}

{{< tab "Request Example" >}}

  • cost_query_set_id (string) Required

{{< highlight json >}} { "cost_query_set_id": "query-16ae671dc8fb", "domain_id": "domain-58010aa2e451" } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

  • cost_query_set_id (string) Required

  • name (string) Required

  • options (Struct) Required

  • tags (Struct) Required

  • domain_id (string) Required

  • workspace_id (string) Required

  • user_id (string) Required

  • data_source_id (string) Required

  • created_at (string) Required

  • updated_at (string) Required

{{< highlight json >}} { "cost_query_set_id": "query-76a58ea5d02c", "name": "project_provider_region", "options": {}, "tags": {}, "user_id": "test@cloudforet.io", "data_source_id": "ds-085d1e872789", "domain_id": "domain-58010aa2e451", "created_at": "2022-07-19T06:11:03.701Z", "updated_at": "2022-07-19T06:11:03.701Z" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

list

Gets a list of all CostQuerySets. You can use a query to get a filtered list of CostQuerySets.

POST /cost-analysis/v1/cost-query-set/list

{{< tabs " list " >}}

{{< tab "Request Example" >}}

  • data_source_id (string) Required

  • query (Query)

  • name (string)

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

{{< tab "Response Example" >}}

  • results (CostQuerySetInfo) Repeated Required

  • total_count (int32) Required

{{< highlight json >}} { "results": [ { "cost_query_set_id": "query-16ae671dc8fb", "name": "3 month product pie chart", "options": {}, "tags": {}, "user_id": "yuda@mz.co.kr", "data_source_id": "ds-085d1e872789", "domain_id": "domain-58010aa2e451", "created_at": "2022-03-08T03:37:31.404Z", "updated_at": "2022-03-08T03:37:31.404Z" }, { "cost_query_set_id": "query-d90addf25e4b", "name": "6 month project group", "options": {}, "tags": {}, "user_id": "yuda@mz.co.kr", "data_source_id": "ds-085d1e872789", "domain_id": "domain-58010aa2e451", "created_at": "2022-03-14T09:29:54.306Z", "updated_at": "2022-03-14T09:29:54.306Z" } ], "total_count": 34 } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

stat

POST /cost-analysis/v1/cost-query-set/stat

Message

CostQuerySetInfo

  • cost_query_set_id (string) Required

  • name (string) Required

  • options (Struct) Required

  • tags (Struct) Required

  • domain_id (string) Required

  • workspace_id (string) Required

  • user_id (string) Required

  • data_source_id (string) Required

  • created_at (string) Required

  • updated_at (string) Required

CostQuerySetQuery

  • data_source_id (string) Required

  • query (Query)

  • name (string)

CostQuerySetRequest

  • cost_query_set_id (string) Required

CostQuerySetStatQuery

  • query (StatisticsQuery) Required

  • data_source_id (string) Required

CostQuerySetsInfo

  • results (CostQuerySetInfo) Repeated Required

  • total_count (int32) Required

CreateCostQuerySetRequest

  • data_source_id (string) Required

  • name (string) Required

  • options (Struct) Required

  • tags (Struct)

UpdateCostQuerySetRequest

  • cost_query_set_id (string) Required

  • name (string)

  • options (Struct)

  • tags (Struct)

PreviousCostNextCostReport

Last updated 1 year ago

CreateCostQuerySetRequest
UpdateCostQuerySetRequest
CostQuerySetRequest
CostQuerySetRequest
CostQuerySetQuery
CostQuerySetInfo
CostQuerySetInfo
CostQuerySetInfo
CostQuerySetsInfo
create
CreateCostQuerySetRequest
CostQuerySetInfo
update
UpdateCostQuerySetRequest
CostQuerySetInfo
delete
CostQuerySetRequest
Empty
get
CostQuerySetRequest
CostQuerySetInfo
list
CostQuerySetQuery
CostQuerySetsInfo
stat
CostQuerySetStatQuery
Struct