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

# Metric

A Metric is a monitoring metric of a specific cloud service delivered from a DataSource.

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

\ <br>

## Metric

**Metric Methods:**

| Method                                                                                                                   | Request                                                                                                                               | Response                                                                                                                        |
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| [**list**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/monitoring/v1/Metric/README.md#list)          | [MetricRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/monitoring/v1/Metric/README.md#metricrequest)         | [MetricsInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/monitoring/v1/Metric/README.md#metricsinfo)       |
| [**get\_data**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/monitoring/v1/Metric/README.md#get_data) | [MetricDataRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/monitoring/v1/Metric/README.md#metricdatarequest) | [MetricDataInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/monitoring/v1/Metric/README.md#metricdatainfo) |

<br>

### list

Gets a list of all Metrics of one or more specified Resources. The parameter `resources` is a list of Resources from which to get a list of Metrics collected.

> **POST** /monitoring/v1/metric/list

{{< tabs " list " >}}

{{< tab "Request Example" >}}

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

* **data\_source\_id** (string) `Required`
* **resources** (string) `Repeated` `Required`

{{< highlight json >}} { "data\_source\_id": "ds-31190a65a42a", "resources": \["cloud-svc-cd0105d255da"], "domain\_id": "domain-58010aa2e451" } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

[MetricsInfo](#METRICSINFO)

* **metrics** (MetricInfo) `Repeated` `Required`
* **available\_resources** (Struct) `Required`
* **domain\_id** (string) `Required`

{{< highlight json >}} { "metrics": \[ { "key": "CPUUtilization", "group": "AWS/EC2", "name": "CPUUtilization", "unit": { "y": "Percent", "x": "Timestamp" }, "metric\_query": { "cloud-svc-cd0105d255da": { "Dimensions": \[ { "Name": "InstanceId", "Value": "i-0400cdd39f1a4d5e9" } ], "MetricName": "CPUUtilization", "Namespace": "AWS/EC2" } } }, { "key": "NetworkIn", "group": "AWS/EC2", "name": "NetworkIn", "unit": { "y": "Bytes", "x": "Timestamp" }, "metric\_query": { "cloud-svc-cd0105d255da": { "Dimensions": \[ { "Name": "InstanceId", "Value": "i-0400cdd39f1a4d5e9" } ], "MetricName": "NetworkIn", "Namespace": "AWS/EC2" } } } ], "available\_resources": { "cloud-svc-cd0105d255da": true }, "domain\_id": "domain-31190a65a42a" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

<br>

### get\_data

Gets data of a single Metric. You must specify the parameter `metric` to get data of. You can specify the `period` to get data for.

> **POST** /monitoring/v1/metric/get-data

{{< tabs " get\_data " >}}

{{< tab "Request Example" >}}

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

* **data\_source\_id** (string) `Required`
* **metric\_query** (Struct) `Required`
* **metric** (string) `Required`
* **start** (string) `Required`
* **end** (string) `Required`
* **period** (int32)
* **stat** (string)

{{< highlight json >}} { "data\_source\_id": "ds-31190a65a42a", "metric\_query": { "cloud-svc-cd0105d255da": { "Dimensions": \[ { "Name": "InstanceId", "Value": "i-0400cdd39f1a4d5e9" } ], "MetricName": "CPUUtilization", "Namespace": "AWS/EC2" } }, "metric": "CPUUtilization", "start": "2022-06-21T03:11:29.438Z", "end": "2022-06-21T04:11:29.438Z", "stat": "AVERAGE", "domain\_id": "domain-58010aa2e451" } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

[MetricDataInfo](#METRICDATAINFO)

* **labels** (ListValue) `Required`
* **values** (Struct) `Required`
* **domain\_id** (string) `Required`

{{< highlight json >}} { "labels": \[ "2022-06-21T03:13:00.000Z", "2022-06-21T03:18:00.000Z", "2022-06-21T03:23:00.000Z", "2022-06-21T03:28:00.000Z", "2022-06-21T03:33:00.000Z", "2022-06-21T03:38:00.000Z", "2022-06-21T03:43:00.000Z", "2022-06-21T03:48:00.000Z", "2022-06-21T03:53:00.000Z", "2022-06-21T03:58:00.000Z", "2022-06-21T04:03:00.000Z", "2022-06-21T04:08:00.000Z" ], "resource\_values": { "cloud-svc-cd0105d255da": \[ 0.099999999999999, 0.10001852366397981, 0.10001852366397981, 0.1328230362675432, 0.099472075576548, 0.06507936507936621, 0.166703713994628, 0.1338983050847476, 0.1327868852458988, 0.1339168287487284, 0.1328610417160508, 0.10056497175141618 ] }, "domain\_id": "domain-58010aa2e451" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

\ <br>

## Message

### MetricDataInfo

* **labels** (ListValue) `Required`
* **values** (Struct) `Required`
* **domain\_id** (string) `Required`

  <br>

### MetricDataRequest

* **data\_source\_id** (string) `Required`
* **metric\_query** (Struct) `Required`
* **metric** (string) `Required`
* **start** (string) `Required`
* **end** (string) `Required`
* **period** (int32)
* **stat** (string)

  <br>

### MetricInfo

* **key** (string) `Required`
* **name** (string) `Required`
* **group** (string) `Required`
* **unit** (Struct) `Required`
* **metric\_query** (Struct) `Required`

  <br>

### MetricRequest

* **data\_source\_id** (string) `Required`
* **resources** (string) `Repeated` `Required`

  <br>

### MetricsInfo

* **metrics** (MetricInfo) `Repeated` `Required`
* **available\_resources** (Struct) `Required`
* **domain\_id** (string) `Required`

  <br>