Get cluster list

Prev Next

Available in VPC

Get search engine cluster list.

Request

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

Method URI
GET /api/v2/cluster/getClusterInfoList (Korea Region)
GET /api/sgn-v2/cluster/getClusterInfoList (Singapore Region)
GET /api/jpn-v2/cluster/getClusterInfoList (Japan Region)

Request headers

For information about the headers common to all Search Engine Service APIs, see Search Engine Service request headers.

Request query parameters

You can use the following query parameters with 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 GET 'https://vpcsearchengine.apigw.ntruss.com/api/v2/cluster/getClusterInfoList?pageNo=1&pageSize=20&inputText=cluster&vpcName=myvpc' \
--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.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
result.disallowedClusters Array - List of clusters without permissions
  • When calling with a sub account, clusters for which getClusterDetail permission is not applied are displayed.
requestId String - ID for the request
  • UUID format

result.allowedClusters

The following describes result.allowedClusters.

Field Type Required Description
clusterName String - Cluster name
dataNodeType String - Data node type
dataNodeProductName String - Data node server type name
dataNodeCount Integer - Number of data nodes
clusterStatus String - Cluster status
searchEngineStatus String - Search engine status
searchEngineVersion String - Search engine version
softwareProductName String - Operating system version
createDate String - Cluster creation date and time
managerNodeType String - Manager node type
managerNodeCount Integer - Number of manager nodes
dataStorageVolumeSize Integer - Data node storage capacity
managerNodeAccessControlGroupSequence Integer - Manager node ACG ID
managerNodeAccessControlGroupName String - Manager node ACG name
dataNodeAccessControlGroupSequence Integer - Data node ACG ID
dataNodeAccessControlGroupName String - ACG name of the data node
searchEnginePort String - Search engine port number
searchEngineDashboardPort String - Dashboard port number
loginKeyName String - Authentication key name
serviceGroupInstanceNo String - Cluster instance number
searchEngineUserName String - Search engine access 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
dataNodeSubnetName String - Data node subnet name
dataNodeSubnetNo Integer - Data node subnet number
isPluginInstalled Boolean - Object Storage plugin (S3 repository) installation status
  • true (default) | false
    • true: installed
    • false: not installed
isDualManager Boolean - Manager node redundancy
  • true | false
    • true: redundant
    • false: no redundancy
accessKeyId String - API authentication key for Object Storage access
  • Displayed if the Object Storage access API authentication key is set for creating cluster snapshots
isMasterOnlyNodeActivated Boolean - Whether master node is enabled
  • true | false
    • true: enabled
    • false: disabled
masterNodeAccessControlGroupSequence Integer - Master node ACG ID
masterNodeAccessControlGroupName String - Master node ACG name
masterNodeSubnetName String - Master node subnet name
masterNodeSubnetNo Integer - Master node subnet number
masterNodeType String - Master node type
masterNodeProductName String - Master node server type name
masterNodeCount Integer - Number of master nodes

result.disallowedClusters

The following describes result.disallowedClusters.

Field Type Required Description
clusterName String - Cluster name
clusterStatus String - Cluster status
searchEngineStatus String - Search engine status
serviceGroupInstanceNo String - Cluster instance number

Response status codes

For response status codes common to all Search Engine Service APIs, see Search Engine Service response status codes.

Response example

The response example is as follows:

{
    "code": 0,
    "message": "SUCCESS",
    "result": {
        "currentPage": 1,
        "isFirst": true,
        "isLast": true,
        "pageSize": 20,
        "totalCount": 5,
        "totalPage": 1,
        "allowedClusters": [
            {
                "clusterName": "cluster000",
                "dataNodeType": "[STAND] 2vCPU, 8GB Mem",
                "dataNodeProductName": "2 vCPUs, 8 GB memory, 50 GB [SSD] disk",
                "dataNodeCount": 3,
                "clusterStatus": "running",
                "searchEngineStatus": "green",
                "searchEngineVersion": "OpenSearch 2.14.0",
                "softwareProductName": "CentOS 7.8 (64-bit)",
                "createDate": "2025-03-20 11:31:48",
                "managerNodeType": "[STAND] 2vCPU, 8GB Mem",
                "managerNodeCount": 2,
                "dataStorageVolumeSize": 322122547200,
                "managerNodeAccessControlGroupSequence": 249484,
                "managerNodeAccessControlGroupName": "searchengine-m-1pr1dg",
                "dataNodeAccessControlGroupSequence": 249483,
                "dataNodeAccessControlGroupName": "searchengine-do-1pr1dg",
                "searchEnginePort": "9200",
                "searchEngineDashboardPort": "5601",
                "loginKeyName": "loginkey01",
                "serviceGroupInstanceNo": "1037*****",
                "searchEngineUserName": "userid",
                "memberNo": "279****",
                "vpcName": "myvpc",
                "vpcNo": 9****,
                "managerNodeSubnetName": "s1-hd-pri | KR-2 | Private",
                "managerNodeSubnetNo": 20****,
                "dataNodeSubnetName": "s1-hd-pri | KR-2 | Private",
                "dataNodeSubnetNo": 20****,
                "isPluginInstalled": true,
                "isDualManager": true,
                "accessKeyId": "******************",
                "isMasterOnlyNodeActivated": true,
                "masterNodeAccessControlGroupSequence": 249485,
                "masterNodeAccessControlGroupName": "searchengine-mo-1pr1dg",
                "masterNodeSubnetName": "s1-hd-pri | KR-2 | Private",
                "masterNodeSubnetNo": 20****,
                "masterNodeType": "[STAND] 2vCPU, 8GB Mem",
                "masterNodeProductName": "2 vCPUs, 8 GB memory, 50 GB [SSD] disk",
                "masterNodeCount": 3
            },
            ...
        ],
        "disallowedClusters": [
            {
                "clusterName": "cluster007",
                "clusterStatus": "running",
                "searchEngineStatus": "green",
                "serviceGroupInstanceNo": "1037*****"
            },
            ...
        ]
    },
    "requestId": "ecc71c59-****-****-****-a46b472f04c4"
}