---
title: "OSモニタリング結果の照会"
slug: "analytics-vpcsearchengine-monitoring-getosmonitoringdata"
tags: ["Search Engine Service"]
updated: 2026-09-17T09:57:29Z
published: 2026-09-17T09:57:29Z
canonical: "api.ncloud-docs.com/analytics-vpcsearchengine-monitoring-getosmonitoringdata"
---

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

# OSモニタリング結果の照会

VPC環境で利用できます。

Search Engineノードサーバの OSモニタリングデータを照会します。

## リクエスト

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

| メソッド | URI |
| --- | --- |
| GET | /api/v2/monitoring/getOsMonitoringData/{serviceGroupInstanceNo} (韓国リージョン) |
| GET | /api/sgn-v2/monitoring/getOsMonitoringData/{serviceGroupInstanceNo} (シンガポールリージョン) |
| GET | /api/jpn-v2/monitoring/getOsMonitoringData/{serviceGroupInstanceNo} (日本リージョン) |

### リクエストヘッダ

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

### リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `serviceGroupInstanceNo` | Integer | Required | クラスタインスタンス番号 - [クラスタリストの照会](/docs/ja/analytics-vpcsearchengine-cluster-getclusterinfolist)を参照 |

### リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `timeStart` | Integer | Required | 照会開始日時(ミリ秒) - Unix Timestamp形式 |
| `timeEnd` | Integer | Required | 照会終了日時(ミリ秒) - Unix Timestamp形式 |
| `metric` | String | Required | Metricタイプ - `OS_ALL_METRICS`: OSモニタリング Metric (有効値) |
| `computeInstanceNo` | Integer | Required | ノードサーバインスタンス番号 - [ノードリストの照会](/docs/ja/analytics-vpcsearchengine-cluster-getclusternodelist)を参照 |
| `interval` | String | Optional | 集計周期 - `Min1` (デフォルト) \| `Min5` \| `Min30` \| `Hour2` \| `Day1` - `Min1`: 1分(最大1日) - `Min5`: 5分(最大1週間) - `Min30`: 30分(最大1か月) - `Hour2`: 2時間(最大3か月) - `Day1`: 1日(最大1年) |

### リクエスト例

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

```
curl --location --request GET 'https://vpcsearchengine.apigw.ntruss.com/api/v2/monitoring/getOsMonitoringData/1037****?timeStart=1742520660000&timeEnd=1742866674000&metric=OS_ALL_METRICS&computeInstanceNo=1037*****' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
```

## レスポンス

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

### レスポンスボディ

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

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `code` | Integer | - | レスポンスコード |
| `message` | String | - | レスポンスメッセージ |
| `result` | Object | - | レスポンス結果 |
| `result.data` | Array | - | モニタリングデータ: [data](/docs/ja/analytics-vpcsearchengine-monitoring-getosmonitoringdata#data) |
| `requestId` | String | - | リクエスト ID - UUID形式 |

#### `data`

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

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `dps` | Array | - | 照会結果 - データポイント(Unix Timestamp形式)、データの値の形式で表示 |
| `aggregation` | String | - | 集計関数 |
| `dimensions` | Object | - | Dimension情報 |
| `dimensions.instanceNo` | String | - | ノードのサーバインスタンス番号 |
| `dimensions.Svc_group_instance_no` | String | - | クラスタインスタンス番号 |
| `interval` | String | - | 集計周期 - `Min1` \| `Min5` \| `Min30` \| `Hour2` \| `Day1` - `Min1`: 1分(最大1日) - `Min5`: 5分(最大1週間) - `Min30`: 30分(最大1か月) - `Hour2`: 2時間(最大3か月) - `Day1`: 1日(最大1年) |
| `metric` | String | - | Metricの名前 |
| `graphName` | String | - | グラフ名 |
| `productName` | String | - | 商品名 |

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

Search Engine Service APIで共通して使用されるレスポンスステータスコードの詳細は、[Search Engine Serviceのレスポンスステータスコード](/docs/ja/analytics-vpcsearchengine#%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C)をご参照ください。

### レスポンス例

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

```
{
    "code": 0,
    "message": "SUCCESS",
    "result": {
        "data": [
            {
                "dps": [
                    [
                        1742522400000,
                        0.2895593
                    ],
                    [
                        1742524200000,
                        0.20599635
                    ],
                    [
                        1742526000000,
                        0.15053034
                    ],
                    ...
                ],
                "aggregation": "AVG",
                "dimensions": {
                    "instanceNo": "1037*****",
                    "Svc_group_instance_no": "1037*****"
                },
                "interval": "Min30",
                "metric": "wait i/o",
                "graphName": "CPU Usage(%)",
                "productName": "Search Engine Service(VPC)"
            },
            {
                "dps": [
                    [
                        1742522400000,
                        3.7677953
                    ],
                    [
                        1742524200000,
                        2.5108845
                    ],
                    [
                        1742526000000,
                        1.9430301
                    ],
                    ...
                ],
                "aggregation": "AVG",
                "dimensions": {
                    "instanceNo": "1037*****",
                    "Svc_group_instance_no": "1037*****"
                },
                "interval": "Min30",
                "metric": "user",
                "graphName": "CPU Usage(%)",
                "productName": "Search Engine Service(VPC)"
            },
            ...
        ]
    },
    "requestId": "0065bc1b-****-****-****-4046e17d4407"
}
```