---
title: "OSモニタリング結果の照会"
slug: "analytics-clouddatastreamingservice-monitoring-getosmonitoring"
updated: 2026-09-17T09:57:32Z
published: 2026-09-17T09:57:32Z
canonical: "api.ncloud-docs.com/analytics-clouddatastreamingservice-monitoring-getosmonitoring"
---

> ## 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環境で利用できます。

Cloud Data Streaming Serviceクラスタのブローカーノードサーバの OSモニタリングデータを照会します。

## リクエスト

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

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

### リクエストヘッダ

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

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

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

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

### リクエストボディ

リクエストボディの説明は次の通りです。

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `timeStart` | Long | Required | 照会開始日時(ミリ秒) - Unix Timestamp形式 |
| `timeEnd` | Long | Required | 照会終了日時(ミリ秒) - Unix Timestamp形式 |
| `metric` | String | Required | Metricタイプ - `OS_ALL_METRICS`: OSモニタリング Metric (有効値) |
| `computeInstanceNo` | String | Required | ノードサーバインスタンス番号 - [ノードリストの照会](/docs/ja/analytics-clouddatastreamingservice-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 POST 'https://clouddatastreamingservice.apigw.ntruss.com/api/v1/monitoring/getOsMonitoringData/1009*****' \
--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 '{
    "timeStart": "1745280000000",
    "timeEnd": "1745409600000",
    "metric": "OS_ALL_METRICS",
    "computeInstanceNo": "1009*****",
    "interval": "Hour2"
}'
```

## レスポンス

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

### レスポンスボディ

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

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

#### `data`

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

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `dps` | Array | - | 照会結果 - データポイント(Unix Timestamp形式)、データの値の形式で表示 |
| `aggregation` | String | - | 集計関数 |
| `dimensions` | Object | - | Dimension情報 |
| `dimensions.instanceNo` | 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 | - | 商品名 |

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

Cloud Data Streaming Service APIで共通して使用されるレスポンスステータスコードの詳細は、[Cloud Data Streaming Serviceのレスポンスステータスコード](/docs/ja/analytics-clouddatastreamingservice#%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": [
                    [
                        1745283600000,
                        0.07082558
                    ],
                    [
                        1745290800000,
                        0.06998591
                    ],
                    ...
                ],
                "aggregation": "AVG",
                "dimensions": {
                    "instanceNo": "1009*****"
                },
                "interval": "Hour2",
                "metric": "wait i/o",
                "graphName": "CPU Usage(%)",
                "productName": "Cloud Data Streaming Service(VPC)"
            },
            {
                "dps": [
                    [
                        1745283600000,
                        1.0979123
                    ],
                    [
                        1745290800000,
                        1.0971684
                    ],
                    ...
                ],
                "aggregation": "AVG",
                "dimensions": {
                    "instanceNo": "1009*****"
                },
                "interval": "Hour2",
                "metric": "user",
                "graphName": "CPU Usage(%)",
                "productName": "Cloud Data Streaming Service(VPC)"
            },
            ...
        ]
    },
    "requestId": "bf9041b5-****-****-****-20d77d5b08d7"
}
```