---
title: "クラスタ状態の照会"
slug: "analytics-clouddatastreamingservice-cluster-getclusterstatus"
updated: 2026-10-08T07:22:12Z
published: 2026-10-08T07:22:12Z
canonical: "api.ncloud-docs.com/analytics-clouddatastreamingservice-cluster-getclusterstatus"
---

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

# クラスタ状態の照会

VPC環境で利用できます。

Cloud Data Streaming Serviceクラスタの現在の状態を照会します。

## リクエスト

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

| メソッド | URI |
| --- | --- |
| GET | /api/v1/cluster/getClusterStatus/{serviceGroupInstanceNo} (韓国リージョン) |
| GET | /api/sgn-v1/cluster/getClusterStatus/{serviceGroupInstanceNo} (シンガポールリージョン) |
| GET | /api/jpn-v1/cluster/getClusterStatus/{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)を参照 |

### リクエスト例

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

```
curl --location --request GET 'https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/getClusterStatus/1009*****' \
--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.clusterName` | String | - | クラスタ名 |
| `result.brokerNodeTotalNumber` | Integer | - | ブローカーノードの総数 |
| `result.brokerNumber` | Integer | - | 現在動作中のブローカーノード数 |
| `result.brokerStatus` | String | - | ノードブローカーの平均的な状態 - `green` \| `yellow` \| `orange` \| `red` \| `gray` - `green`: 正常 - `yellow`: 一部異常 - `orange`: 変更中 - `red`: 異常 - `gray`: 不明 |
| `result.brokerStatusPerNode` | Array | - | ノードごとのブローカーの状態: [brokerStatusPerNode](/docs/ja/analytics-clouddatastreamingservice-cluster-getclusterstatus#brokerStatusPerNode) |
| `result.zookeeperTotalNumber` | Integer | - | ZooKeeperノードの総数 |
| `result.zookeeperNumber` | Integer | - | 現在動作中の ZooKeeperノード数 |
| `result.zookeeperStatus` | String | - | ノード ZooKeeperの平均的な状態 - `green` \| `yellow` \| `orange` \| `red` \| `gray` - `green`: 正常 - `yellow`: 一部異常 - `orange`: 変更中 - `red`: 異常 - `gray`: 不明 |
| `result.zookeeperStatusPerNode` | Array | - | ノードごとの ZooKeeperの状態: [zookeeperStatusPerNode](/docs/ja/analytics-clouddatastreamingservice-cluster-getclusterstatus#zookeeperStatusPerNode) |
| `result.cmakStatus` | String | Deprecated | CMAKの状態 - `green` \| `yellow` \| `orange` \| `red` \| `gray` - `green`: 正常 - `yellow`: 一部異常 - `orange`: 変更中 - `red`: 異常 - `gray`: 不明 |
| `requestId` | String | - | リクエスト ID - UUID形式 |

#### `brokerStatusPerNode`

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

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `hostname` | String | - | サーバインスタンス名 |
| `status` | String | - | プロセスの状態 - `green` \| `yellow` \| `orange` \| `red` \| `gray` - `green`: 正常 - `yellow`: 一部異常 - `orange`: 変更中 - `red`: 異常 - `gray`: 不明 |

#### `zookeeperStatusPerNode`

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

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `hostname` | String | - | サーバインスタンス名 |
| `status` | String | - | プロセスの状態 - `green` \| `yellow` \| `orange` \| `red` \| `gray` - `green`: 正常 - `yellow`: 一部異常 - `orange`: 変更中 - `red`: 異常 - `gray`: 不明 |

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

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": {
        "clusterName": "cluster00",
        "brokerNodeTotalNumber": 3,
        "brokerNumber": 3,
        "brokerStatus": "green",
        "brokerStatusPerNode": [
            {
                "hostname": "cluster00-b-25t6",
                "status": "green"
            },
            {
                "hostname": "cluster00-b-25t7",
                "status": "green"
            },
            {
                "hostname": "cluster00-b-25t8",
                "status": "green"
            }
        ],
        "zookeeperTotalNumber": 3,
        "zookeeperNumber": 3,
        "zookeeperStatus": "green",
        "zookeeperStatusPerNode": [
            {
                "hostname": "cluster00-b-25t6",
                "status": "green"
            },
            {
                "hostname": "cluster00-b-25t7",
                "status": "green"
            },
            {
                "hostname": "cluster00-b-25t8",
                "status": "green"
            }
        ],
        "cmakStatus": "green"
    },
    "requestId": "9c3385a5-****-****-****-a45e45f01228"
}
```