---
title: "Get cluster list"
slug: "analytics-clouddatastreamingservice-cluster-getclusterinfolist"
updated: 2026-10-08T04:21:39Z
published: 2026-10-08T04:21:39Z
canonical: "api.ncloud-docs.com/analytics-clouddatastreamingservice-cluster-getclusterinfolist"
---

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

Available in VPC

Get the list of Cloud Data Streaming Service clusters.

## Request

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

| Method | URI |
| --- | --- |
| POST | /api/v1/cluster/getClusterInfoList (Korea Region) |
| POST | /api/sgn-v1/cluster/getClusterInfoList (Singapore Region) |
| POST | /api/jpn-v1/cluster/getClusterInfoList (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 body

You can include the following data in the body of your request:

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `inputText` | String | Optional | Search keyword - Filter values that match the cluster name in whole or in part. |
| `vpcName` | String | Optional | VPC name - Filter only values that match exactly. |
| `pageNo` | Integer | Optional | Page number - 1-N (default: 1) |
| `pageSize` | Integer | Optional | Page output count - 1-N (default: 10) |

### Request example

The request example is as follows:

```
curl --location --request POST 'https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/getClusterInfoList' \
--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 '{
  "inputText" : "c",
  "vpcName": "test-vpc2",
  "pageNo" : 1,
  "pageSize" : 10
}'
```

## 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.currentPage` | Integer | - | Current page number |
| `result.isFirst` | Boolean | - | Whether it is the first page - `true` \| `false` - `true`: First page - `false`: Not a first page |
| `result.isLast` | Boolean | - | Whether it is the last page - `true` \| `false` - `true`: Last page - `false`: Not a last page |
| `result.pageSize` | Integer | - | Page output count |
| `result.totalCount` | Integer | - | Number of response results |
| `result.totalPage` | Integer | - | Total number of pages |
| `result.allowedClusters` | Array | - | Cluster list: [allowedClusters](/docs/en/analytics-clouddatastreamingservice-cluster-getclusterinfolist#allowedClusters) |
| `result.disallowedClusters` | Array | - | List of clusters without permissions: [disallowedClusters](/docs/en/analytics-clouddatastreamingservice-cluster-getclusterinfolist#disallowedClusters) - When calling with a sub account, clusters for which getClusterDetail permission is not applied are displayed. |
| `requestId` | String | - | ID for the request - UUID format |

#### `allowedClusters`

The following describes `allowedClusters`.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `clusterName` | String | - | Cluster name |
| `brokerNodeType` | String | - | Broker node type |
| `brokerNodeProductName` | String | - | Broker node server type name |
| `brokerNodeCount` | Integer | - | Number of broker nodes |
| `brokerNodePublicEndpoint` | String | - | Broker node public endpoint - If public endpoint is enabled, display valid values. |
| `isUsePublicEndpoint` | Boolean | - | Whether the broker node public endpoint is enabled |
| `serverStatus` | String | - | Server status |
| `applicationVersion` | String | - | Cloud Data Streaming Service version |
| `kafkaVersion` | String | - | Kafka version |
| `cmakVersion` | String | Deprecated | CMAK version |
| `softwareProductName` | String | - | Operating system version |
| `createDate` | Date | - | Cluster creation date and time |
| `managerNodeType` | String | - | Manager node type |
| `managerNodeCount` | Integer | - | Number of manager nodes |
| `clusterPublicDomain` | String | - | Public domain for management tool access |
| `isUsePublicDomain` | Boolean | - | Whether public domain is enabled |
| `brokerStorageVolumeSize` | Long | - | Broker node storage capacity (GB) |
| `managerNodeAccessControlGroupSequence` | Integer | - | Manager node ACG ID |
| `managerNodeAccessControlGroupName` | String | - | Manager node ACG name |
| `brokerNodeAccessControlGroupSequence` | Integer | - | Broker node ACG ID |
| `brokerNodeAccessControlGroupName` | String | - | Name of the broker node ACG |
| `kafkaBrokerPort` | Integer | - | Broker node port number |
| `kafkaBrokerTlsPort` | Integer | - | Broker node TLS port number |
| `zookeeperPort` | Integer | - | ZooKeeper node port number |
| `cmakPort` | Integer | Deprecated | CMAK access port number |
| `serviceGroupInstanceNo` | String | - | Cluster instance number |
| `kafkaManagerUserName` | String | - | Manager tool access account ID |
| `memberNo` | String | - | User's NAVER Cloud Platform member ID |
| `vpcName` | String | - | VPC name |
| `vpcNo` | Integer | - | VPC number |
| `managerNodeSubnetName` | String | - | Manager node subnet name |
| `managerNodeSubnetNo` | Integer | - | Manager node subnet number |
| `brokerNodeSubnetName` | String | - | Broker node subnet name |
| `brokerNodeSubnetNo` | Integer | - | Broker node subnet number |
| `configGroupNo` | Integer | - | Config group number |
| `configGroupName` | String | - | Config group name |

#### `disallowedClusters`

The following describes `disallowedClusters`.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `clusterName` | String | - | Cluster name |
| `serviceGroupInstanceNo` | String | - | Cluster instance number |

### 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": {
        "currentPage": 1,
        "isFirst": true,
        "isLast": true,
        "pageSize": 10,
        "totalCount": 2,
        "totalPage": 1,
        "allowedClusters": [
            {
                "clusterName": "cluster00",
                "brokerNodeType": "[STAND] 2vCPU, 8GB Mem",
                "brokerNodeProductName": "2 vCPUs, 8 GB memory, 50 GB [SSD] disk",
                "brokerNodeCount": 3,
                "brokerNodePublicEndpoint": null,
                "isUsePublicEndpoint": false,
                "serverStatus": "running",
                "applicationVersion": "Kafka 3.9.0, CMAK 3.0.0.6",
                "kafkaVersion": "3.9.0",
                "cmakVersion": "3.0.0.6",
                "softwareProductName": "CentOS 7.8 (64-bit)",
                "createDate": "2025-04-16 09:37:24",
                "managerNodeType": "[STAND] 2vCPU, 8GB Mem",
                "managerNodeCount": 1,
                "clusterPublicDomain": "****************************************",
                "isUsePublicDomain": false,
                "brokerStorageVolumeSize": 322122547200,
                "managerNodeAccessControlGroupSequence": 5****,
                "managerNodeAccessControlGroupName": "cdss-m-1o2xag",
                "brokerNodeAccessControlGroupSequence": 5****,
                "brokerNodeAccessControlGroupName": "cdss-b-1o2xag",
                "kafkaBrokerPort": 9092,
                "kafkaBrokerTlsPort": 9093,
                "zookeeperPort": 2181,
                "cmakPort": 9000,
                "serviceGroupInstanceNo": "1009*****",
                "kafkaManagerUserName": "userid",
                "memberNo": "500****",
                "vpcName": "test-vpc2",
                "vpcNo": 4***,
                "managerNodeSubnetName": "sb2 | KR-2 | Private",
                "managerNodeSubnetNo": 33***,
                "brokerNodeSubnetName": "sb2 | KR-2 | Private",
                "brokerNodeSubnetNo": 33***,
                "configGroupNo": 3**,
                "configGroupName": "cg1"
            }
        ],
        "disallowedClusters": [
            {
                "clusterName": "cluster01",
                "serviceGroupInstanceNo": "1009*****"
            }
        ]
    },
    "requestId": "f6713e31-****-****-****-665ad3ebda9c"
}
```