> 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/inventory/v1/metric.md).

# Metric

> **Package : spaceone.api.inventory.v1**

\ <br>

## Metric

**Metric Methods:**

| Method                                                                                                             | Request                                                                                                                                  | Response                                                                                                                 |
| ------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
| [**create**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/Metric/README.md#create) | [CreateMetricRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/Metric/README.md#createmetricrequest) | [MetricInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/Metric/README.md#metricinfo)   |
| [**update**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/Metric/README.md#update) | [UpdateMetricRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/Metric/README.md#updatemetricrequest) | [MetricInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/Metric/README.md#metricinfo)   |
| [**delete**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/Metric/README.md#delete) | [MetricRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/Metric/README.md#metricrequest)             | [Empty](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/Metric/README.md#empty)             |
| [**run**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/Metric/README.md#run)       | [MetricRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/Metric/README.md#metricrequest)             | [Empty](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/Metric/README.md#empty)             |
| [**test**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/Metric/README.md#test)     | [MetricTestRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/Metric/README.md#metrictestrequest)     | [Struct](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/Metric/README.md#struct)           |
| [**get**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/Metric/README.md#get)       | [MetricRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/Metric/README.md#metricrequest)             | [MetricInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/Metric/README.md#metricinfo)   |
| [**list**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/Metric/README.md#list)     | [MetricQuery](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/Metric/README.md#metricquery)                 | [MetricsInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/Metric/README.md#metricsinfo) |
| [**stat**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/Metric/README.md#stat)     | [MetricStatQuery](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/Metric/README.md#metricstatquery)         | [Struct](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/Metric/README.md#struct)           |

<br>

### create

> **POST** /inventory/v1/metric/create

{{< tabs " create " >}}

{{< tab "Request Example" >}}

[CreateMetricRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/Metric/README.md#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)

{{< highlight json >}} {

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

{{< tab "Response Example" >}}

[MetricInfo](#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`

{{< highlight json >}} {

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

{{< /tabs >}}

<br>

### update

> **POST** /inventory/v1/metric/update

{{< tabs " update " >}}

{{< tab "Request Example" >}}

[UpdateMetricRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/Metric/README.md#updatemetricrequest)

* **metric\_id** (string) `Required`
* **name** (string)
* **query\_options** (AnalyzeQuery)
* **date\_field** (string)
* **unit** (string)
* **tags** (Struct)

{{< highlight json >}} {

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

{{< tab "Response Example" >}}

[MetricInfo](#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`

{{< highlight json >}} {

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

{{< /tabs >}}

<br>

### delete

> **POST** /inventory/v1/metric/delete

{{< tabs " delete " >}}

{{< tab "Request Example" >}}

[MetricRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/Metric/README.md#metricrequest)

* **metric\_id** (string) `Required`

{{< highlight json >}} {

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

{{< /tabs >}}

<br>

### run

> **POST** /inventory/v1/metric/run

{{< tabs " run " >}}

{{< tab "Request Example" >}}

[MetricRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/Metric/README.md#metricrequest)

* **metric\_id** (string) `Required`

{{< highlight json >}} {

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

{{< /tabs >}}

<br>

### test

> **POST** /inventory/v1/metric/test

{{< tabs " test " >}}

{{< tab "Request Example" >}}

[MetricTestRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/Metric/README.md#metrictestrequest)

* **metric\_id** (string) `Required`
* **query\_options** (AnalyzeQuery) `Required`

{{< highlight json >}} {

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

{{< /tabs >}}

<br>

### get

> **POST** /inventory/v1/metric/get

{{< tabs " get " >}}

{{< tab "Request Example" >}}

[MetricRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/Metric/README.md#metricrequest)

* **metric\_id** (string) `Required`

{{< highlight json >}} {

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

{{< tab "Response Example" >}}

[MetricInfo](#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`

{{< highlight json >}} {

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

{{< /tabs >}}

<br>

### list

> **POST** /inventory/v1/metric/list

{{< tabs " list " >}}

{{< tab "Request Example" >}}

[MetricQuery](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/Metric/README.md#metricquery)

* **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 >}}

<br>

### stat

> **POST** /inventory/v1/metric/stat

\ <br>

## 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)

  <br>

### 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`

  <br>

### MetricQuery

* **query** (Query)
* **metric\_id** (string)
* **metric\_type** (MetricType)
* **resource\_type** (string)
* **is\_managed** (string)
* **workspace\_id** (string)
* **namespace\_id** (string)

  <br>

### MetricRequest

* **metric\_id** (string) `Required`

  <br>

### MetricStatQuery

* **query** (StatisticsQuery) `Required`

  <br>

### MetricTestRequest

* **metric\_id** (string) `Required`
* **query\_options** (AnalyzeQuery) `Required`

  <br>

### MetricsInfo

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

  <br>

### UpdateMetricRequest

* **metric\_id** (string) `Required`
* **name** (string)
* **query\_options** (AnalyzeQuery)
* **date\_field** (string)
* **unit** (string)
* **tags** (Struct)

  <br>