> For the complete documentation index, see [llms.txt](https://cloudforet.gitbook.io/cloudforet-apis/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://cloudforet.gitbook.io/cloudforet-apis/content/en/cost_analysis/v1/budgetusage.md).

# BudgetUsage

> **Package : spaceone.api.cost\_analysis.v1**

\ <br>

## BudgetUsage

**BudgetUsage Methods:**

| Method                                                                                                                        | Request                                                                                                                                                   | Response                                                                                                                                    |
| ----------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| [**list**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/cost_analysis/v1/BudgetUsage/README.md#list)       | [BudgetUsageQuery](https://github.com/cloudforet-io/api-doc/blob/master/content/en/cost_analysis/v1/BudgetUsage/README.md#budgetusagequery)               | [BudgetUsagesInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/cost_analysis/v1/BudgetUsage/README.md#budgetusagesinfo) |
| [**analyze**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/cost_analysis/v1/BudgetUsage/README.md#analyze) | [BudgetUsageAnalyzeQuery](https://github.com/cloudforet-io/api-doc/blob/master/content/en/cost_analysis/v1/BudgetUsage/README.md#budgetusageanalyzequery) | [Struct](https://github.com/cloudforet-io/api-doc/blob/master/content/en/cost_analysis/v1/BudgetUsage/README.md#struct)                     |
| [**stat**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/cost_analysis/v1/BudgetUsage/README.md#stat)       | [BudgetUsageStatQuery](https://github.com/cloudforet-io/api-doc/blob/master/content/en/cost_analysis/v1/BudgetUsage/README.md#budgetusagestatquery)       | [Struct](https://github.com/cloudforet-io/api-doc/blob/master/content/en/cost_analysis/v1/BudgetUsage/README.md#struct)                     |

<br>

### list

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

> **POST** /cost-analysis/v1/budget-usage/list

{{< tabs " list " >}}

{{< tab "Request Example" >}}

[BudgetUsageQuery](https://github.com/cloudforet-io/api-doc/blob/master/content/en/cost_analysis/v1/BudgetUsage/README.md#budgetusagequery)

* **query** (Query)
* **name** (string)
* **date** (string)
* **workspace\_id** (string)
* **project\_id** (string)
* **budget\_id** (string)
* **data\_source\_id** (string)

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

{{< tab "Response Example" >}}

[BudgetUsagesInfo](#BUDGETUSAGESINFO)

* **results** (BudgetUsageInfo) `Repeated` `Required`
* **total\_count** (int32) `Required`

{{< highlight json >}} { "results": \[ { "budget\_id": "budget-abb377eb9e8b", "name": "Cloudforet-Budget3", "date": "2022-01", "cost": 7671.164, "limit": 10000.0, "currency": "USD", "provider\_filter": { "state": "ENABLED", "providers": \[ "aws", "google\_cloud" ] }, "project\_id": "project-1b2b3b4b5b6b", "data\_source\_id": "data-source-1b2b3b4b5b6b", "domain\_id": "domain-58010aa2e451", "updated\_at": "2022-07-19T04:26:08.099Z" }, { "budget\_id": "budget-abb377eb9e8b", "name": "Cloudforet-Budget3", "date": "2022-02", "cost": 5931.771, "limit": 11000.0, "currency": "USD", "provider\_filter": { "state": "DISABLED", "providers": \[] }, "project\_id": "project-1b2b3b4b5b6b", "data\_source\_id": "data-source-1b2b3b4b5b6b", "domain\_id": "domain-58010aa2e451", "updated\_at": "2022-07-19T04:26:08.105Z" } ], "total\_count": 12 } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

<br>

### analyze

> **POST** /cost-analysis/v1/budget-usage/analyze

<br>

### stat

> **POST** /cost-analysis/v1/budget-usage/stat

\ <br>

## Message

### BudgetUsageAnalyzeQuery

* **query** (TimeSeriesAnalyzeQuery) `Required`
* **budget\_id** (string)
* **data\_source\_id** (string)

  <br>

### BudgetUsageInfo

* **budget\_id** (string) `Required`
* **name** (string) `Required`
* **date** (string) `Required`
* **cost** (float) `Required`
* **limit** (float) `Required`
* **currency** (string) `Required`
* **provider\_filter** (BudgetUsageProviderFilter) `Required`
* **resource\_group** (ResourceGroup) `Required`
* **data\_source\_id** (string) `Required`
* **project\_id** (string) `Required`
* **workspace\_id** (string) `Required`
* **domain\_id** (string) `Required`
* **updated\_at** (string) `Required`

  <br>

### BudgetUsageProviderFilter

* **state** (State) `Required`
* **providers** (string) `Repeated` `Required`

  <br>

### BudgetUsageQuery

* **query** (Query)
* **name** (string)
* **date** (string)
* **workspace\_id** (string)
* **project\_id** (string)
* **budget\_id** (string)
* **data\_source\_id** (string)

  <br>

### BudgetUsageStatQuery

* **query** (StatisticsQuery) `Required`
* **budget\_id** (string)
* **data\_source\_id** (string)

  <br>

### BudgetUsagesInfo

* **results** (BudgetUsageInfo) `Repeated` `Required`
* **total\_count** (int32) `Required`

  <br>