---
title: "SearchMetricList"
slug: "management-cloudinsight-searchmetriclist"
updated: 2026-09-17T09:57:56Z
published: 2026-09-17T09:57:56Z
canonical: "api.ncloud-docs.com/management-cloudinsight-searchmetriclist"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# SearchMetricList

Classic/VPC環境で利用できます。

監視対象グループで Metricリストを照会します。

## リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

| メソッド | URI |
| --- | --- |
| POST | /cw_fea/real/cw​/api​/rule​/group​/metric​/search |

### リクエストヘッダ

Cloud Insight APIで共通して使用されるヘッダの詳細は、[Cloud Insightのリクエストヘッダ](/docs/ja/management-cloudinsight#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94)をご参照ください。

### リクエストボディ

Metric情報関連フィールドの詳細は、[MetricListRequest](/docs/ja/common-vapidatatype-cimetriclistrequest)をご参照ください。

### リクエスト例

リクエストのサンプルコードは次の通りです。

```
curl --location --request POST 'https://cw.apigw.ntruss.com/cw_fea/real/cw​/api​/rule​/group​/metric​/search' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
    "dimValues": [
        {
            "name": "type",
            "value": "cpu"
        }
    ],
    "query": "used",
    "dimensionsSelectedList": [
      {
        "name": "cpu_idx",
        "values": [
          "0",
          "1"
        ]
      }
    ],
    "prodKey": "**********"
}'
```

## レスポンス

レスポンス形式を説明します。

### レスポンスボディ

レスポンスボディの説明は次の通りです。

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `metrics` | Array | - | Metricリスト: [metrics](/docs/ja/management-cloudinsight-searchmetriclist#metrics) |
| `prodKey` | String | Required | 商品キー(cw_key) - [Cloud Insight指標](/docs/ja/management-cloudinsight-productinfo)を参照 |

#### `metrics`

`metrics`の説明は次の通りです。

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `dataType` | String | - | データタイプ |
| `desc` | String | - | Metricの説明 |
| `dimensions` | Array | - | Dimensionリスト: [dimensions](/docs/ja/management-cloudinsight-searchmetriclist#dimensions) |
| `idDimension` | String | - | Dimension名 |
| `metric` | String | - | Metricの名前 |
| `options` | Object | - | 集計方法 - `"集計周期": [集計関数]`形式で表示 - 集計周期: `Min1` \| `Min5` \| `Min30` \| `Hour2` \| `Day1` - 集計関数: `COUNT` \| `SUM` \| `MAX` \| `MIN` \| `AVG` |
| `prodKey` | String | Required | 商品キー(cw_key) - [Cloud Insight指標](/docs/ja/management-cloudinsight-productinfo)を参照 |
| `unit` | String | - | 単位 |

#### `dimensions`

`dimensions`の説明は次の通りです。

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `dim` | String | - | Dimension名 |
| `val` | String | - | Dimensionの値 |

### レスポンスステータスコード

NAVERクラウドプラットフォームで共通して使用されるレスポンスステータスコードの詳細は、[Cloud Insight APIのレスポンスステータスコード](/docs/ja/management-cloudinsight#%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C)をご参照ください。

### レスポンス例

レスポンスのサンプルコードは次の通りです。

```
{
  "metrics": [
    {
      "dataType": "FLOAT",
      "desc": "used ratio",
      "dimensions": [
        {
          "dim": "type",
          "val": "cpu"
        },
        {
          "dim": "cpu_idx",
          "val": "0"
        }
      ],
      "idDimension": "instanceNo",
      "metric": "used_rto",
      "options": {
        "Min1": [
          "COUNT",
          "SUM",
          "MAX",
          "MIN",
          "AVG"
        ],
        "Min5": [
          "COUNT",
          "SUM",
          "MAX",
          "MIN",
          "AVG"
        ],
        "Min30": [
          "COUNT",
          "SUM",
          "MAX",
          "MIN",
          "AVG"
        ],
        "Hour2": [
          "COUNT",
          "SUM",
          "MAX",
          "MIN",
          "AVG"
        ],
        "Day1": [
          "COUNT",
          "SUM",
          "MAX",
          "MIN",
          "AVG"
        ]
      },
      "prodKey": "**********",
      "unit": "%"
    },
    {
      "dataType": "FLOAT",
      "desc": "used ratio",
      "dimensions": [
        {
          "dim": "type",
          "val": "cpu"
        },
        {
          "dim": "cpu_idx",
          "val": "1"
        }
      ],
      "idDimension": "instanceNo",
      "metric": "used_rto",
      "options": {
        "Min1": [
          "COUNT",
          "SUM",
          "MAX",
          "MIN",
          "AVG"
        ],
        "Min5": [
          "COUNT",
          "SUM",
          "MAX",
          "MIN",
          "AVG"
        ],
        "Min30": [
          "COUNT",
          "SUM",
          "MAX",
          "MIN",
          "AVG"
        ],
        "Hour2": [
          "COUNT",
          "SUM",
          "MAX",
          "MIN",
          "AVG"
        ],
        "Day1": [
          "COUNT",
          "SUM",
          "MAX",
          "MIN",
          "AVG"
        ]
      },
      "prodKey": "**********",
      "unit": "%"
    }
  ],
  "prodKey": "**********"
}
```