---
title: "Get cluster status"
slug: "analytics-clouddatastreamingservice-cluster-getclusterstatus"
updated: 2026-10-08T04:21:34Z
published: 2026-10-08T04:21:34Z
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.

# Get cluster status

Available in VPC

Get the current status of a Cloud Data Streaming Service cluster.

## Request

This section describes the request format. The method and URI are as follows:

| Method | URI |
| --- | --- |
| GET | /api/v1/cluster/getClusterStatus/{serviceGroupInstanceNo} (Korea Region) |
| GET | /api/sgn-v1/cluster/getClusterStatus/{serviceGroupInstanceNo} (Singapore Region) |
| GET | /api/jpn-v1/cluster/getClusterStatus/{serviceGroupInstanceNo} (Japan Region) |

### Request headers

For information about the request headers common to all Cloud Data Streaming Service APIs, see [Cloud Data Streaming Service request headers](/docs/en/analytics-clouddatastreamingservice#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94).

### Request path parameters

You can use the following path parameters with your request:

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `serviceGroupInstanceNo` | Integer | Required | Cluster instance number - See [Get cluster list](/docs/en/analytics-clouddatastreamingservice-cluster-getclusterinfolist). |

### Request example

The request example is as follows:

```
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}'
```

## Response

This section describes the response format.

### Response body

The response body includes the following data:

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | Integer | - | Response code |
| `message` | String | - | Response message |
| `result` | Object | - | Response result |
| `result.clusterName` | String | - | Cluster name |
| `result.brokerNodeTotalNumber` | Integer | - | Total number of broker nodes |
| `result.brokerNumber` | Integer | - | Number of broker nodes currently operating |
| `result.brokerStatus` | String | - | Average broker status of nodes - `green` \| `yellow` \| `orange` \| `red` \| `gray` - `green`: Normal - `yellow`: Some abnormal - `orange`: Changing - `red`: Abnormal - `gray`: Unknown |
| `result.brokerStatusPerNode` | Array | - | Broker status by node: [brokerStatusPerNode](/docs/en/analytics-clouddatastreamingservice-cluster-getclusterstatus#brokerStatusPerNode) |
| `result.zookeeperTotalNumber` | Integer | - | Total number of ZooKeeper nodes |
| `result.zookeeperNumber` | Integer | - | Number of ZooKeeper nodes currently operating |
| `result.zookeeperStatus` | String | - | Average ZooKeeper status of nodes - `green` \| `yellow` \| `orange` \| `red` \| `gray` - `green`: Normal - `yellow`: Some abnormal - `orange`: Changing - `red`: Abnormal - `gray`: Unknown |
| `result.zookeeperStatusPerNode` | Array | - | ZooKeeper status by node: [brokerStatusPerNode](/docs/en/analytics-clouddatastreamingservice-cluster-getclusterstatus#zookeeperStatusPerNode) |
| `result.cmakStatus` | String | Deprecated | CMAK status - `green` \| `yellow` \| `orange` \| `red` \| `gray` - `green`: Normal - `yellow`: Some abnormal - `orange`: Changing - `red`: Abnormal - `gray`: Unknown |
| `requestId` | String | - | ID for the request - UUID format |

#### `brokerStatusPerNode`

The following describes `brokerStatusPerNode`.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `hostname` | String | - | Server instance name |
| `status` | String | - | Process status - `green` \| `yellow` \| `orange` \| `red` \| `gray` - `green`: Normal - `yellow`: Some abnormal - `orange`: Changing - `red`: Abnormal - `gray`: Unknown |

#### `zookeeperStatusPerNode`

The following describes `zookeeperStatusPerNode`.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `hostname` | String | - | Server instance name |
| `status` | String | - | Process status - `green` \| `yellow` \| `orange` \| `red` \| `gray` - `green`: Normal - `yellow`: Some abnormal - `orange`: Changing - `red`: Abnormal - `gray`: Unknown |

### Response status codes

For information about the response status codes common to all Cloud Data Streaming Service APIs, see [Cloud Data Streaming Service response status codes](/docs/en/analytics-clouddatastreamingservice#%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C).

### Response example

The response example is as follows:

```
{
    "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"
}
```