Get cluster

Prev Next

Available in VPC

Get search engine cluster details.

Request

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

Method URI
GET /api/v2/cluster/getClusterInfo/{serviceGroupInstanceNo} (Korea Region)
GET /api/sgn-v2/cluster/getClusterInfo/{serviceGroupInstanceNo} (Singapore Region)
GET /api/jpn-v2/cluster/getClusterInfo/{serviceGroupInstanceNo} (Japan Region)

Request headers

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

Request path parameters

You can use the following path parameters with your request:

Field Type Required Description
serviceGroupInstanceNo Integer Required Cluster instance number

Request example

The request example is as follows:

curl --location --request GET 'https://vpcsearchengine.apigw.ntruss.com/api/v2/cluster/getClusterInfo/1008*****' \
--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.clusterStatus String - Cluster status
result.createDate String - Cluster creation date and time
result.serviceGroupInstanceNo String - Cluster instance number
result.vpcNo Integer - VPC number
result.softwareProductCode String - Operating system type code
result.searchEngineVersionCode String - Search engine version code
result.searchEngineUserName String - Search engine access ID
result.searchEnginePort String - Search engine port number
result.searchEngineDashboardPort String - Dashboard port number
result.isDualManager Boolean - Manager node redundancy
  • true | false
    • true: redundant
    • false: no redundancy
result.managerNodeCount Integer - Number of manager nodes
result.managerNodeSubnetNo Integer - Manager node subnet number
result.managerNodeProductCode String - Manager node server type code
result.managerNodeAcgId Integer - Manager node ACG ID
result.managerNodeAcgName String - Manager node ACG name
result.dataNodeCount Integer - Number of data nodes
result.dataNodeSubnetNo Integer - Data node subnet number
result.dataNodeProductCode String - Data node server type code
result.dataNodeAcgId Integer - Data node ACG ID
result.dataNodeAcgName String - ACG name of the data node
result.dataNodeStorageSize String - Storage capacity by data node (GB)
result.isMasterOnlyNodeActivated Boolean - Whether master node is enabled
  • true | false
    • true: enabled
    • false: disabled
result.masterNodeCount Integer - Number of master nodes
result.masterNodeSubnetNo Integer - Master node subnet number
result.masterNodeProductCode String - Master node server type code
result.masterNodeAcgId Integer - Master node ACG ID
result.masterNodeAcgName String - Master node ACG name
result.loginKeyName String - Authentication key name
result.managerNodeInstanceNoList Array - Manager node instance number list
result.clusterNodeList Array - List of nodes
requestId String - ID for the request
  • UUID format

result.clusterNodeList

The following describes result.clusterNodeList.

Field Type Required Description
computeInstanceName String - Node server name
computeInstanceNo Integer - Node server instance number
privateIp String - Node server internal IP
serverStatus String - Node server status
nodeType String - Node type
subnet String - Subnet name

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": {
        "clusterName": "cluster-kvm000",
        "clusterStatus": "running",
        "createDate": "2025-03-28T10:12:04.488+09:00",
        "serviceGroupInstanceNo": "1008*****",
        "vpcNo": 4***,
        "softwareProductCode": "SW.VELST.OS.LNX64.ROCKY.08.G003",
        "searchEngineVersionCode": "2140",
        "searchEngineUserName": "userid",
        "searchEnginePort": "9200",
        "searchEngineDashboardPort": "5601",
        "isDualManager": true,
        "managerNodeCount": 2,
        "managerNodeSubnetNo": 3****,
        "managerNodeProductCode": "SVR.VELST.STAND.C002.M008.NET.SSD.B050.G003",
        "managerNodeAcgId": 58***,
        "managerNodeAcgName": "searchengine-m-1o0xct",
        "dataNodeCount": 3,
        "dataNodeSubnetNo": 3****,
        "dataNodeProductCode": "SVR.VELST.STAND.C002.M008.NET.SSD.B050.G003",
        "dataNodeAcgId": 58***,
        "dataNodeAcgName": "searchengine-do-1o0xct",
        "dataNodeStorageSize": "200",
        "isMasterOnlyNodeActivated": true,
        "masterNodeCount": 3,
        "masterNodeSubnetNo": 3****,
        "masterNodeProductCode": "SVR.VELST.STAND.C002.M008.NET.SSD.B050.G003",
        "masterNodeAcgId": 58***,
        "masterNodeAcgName": "searchengine-mo-1o0xct",
        "loginKeyName": "loginkey01",
        "managerNodeInstanceNoList": [
            1008*****,
            1008*****
        ],
        "clusterNodeList": [
            {
                "computeInstanceName": "cluster-kvm000-m-24c0",
                "computeInstanceNo": 1008*****,
                "privateIp": "10.0.20.14",
                "serverStatus": "running",
                "nodeType": "Manager",
                "subnet": "sb2 | KR-2 | Private"
            },
            {
                "computeInstanceName": "cluster-kvm000-m-24c1",
                "computeInstanceNo": 1008*****,
                "privateIp": "10.0.20.15",
                "serverStatus": "running",
                "nodeType": "Manager",
                "subnet": "sb2 | KR-2 | Private"
            },
            {
                "computeInstanceName": "cluster-kvm000-mo-24c2",
                "computeInstanceNo": 1008*****,
                "privateIp": "10.0.20.16",
                "serverStatus": "running",
                "nodeType": "Master",
                "subnet": "sb2 | KR-2 | Private"
            },
            {
                "computeInstanceName": "cluster-kvm000-mo-24c3",
                "computeInstanceNo": 1008*****,
                "privateIp": "10.0.20.17",
                "serverStatus": "running",
                "nodeType": "Master",
                "subnet": "sb2 | KR-2 | Private"
            },
            {
                "computeInstanceName": "cluster-kvm000-mo-24c4",
                "computeInstanceNo": 1008*****,
                "privateIp": "10.0.20.18",
                "serverStatus": "running",
                "nodeType": "Master",
                "subnet": "sb2 | KR-2 | Private"
            },
            {
                "computeInstanceName": "cluster-kvm000-do-24c5",
                "computeInstanceNo": 1008*****,
                "privateIp": "10.0.20.19",
                "serverStatus": "running",
                "nodeType": "Data",
                "subnet": "sb2 | KR-2 | Private"
            },
            {
                "computeInstanceName": "cluster-kvm000-do-24c6",
                "computeInstanceNo": 1008*****,
                "privateIp": "10.0.20.20",
                "serverStatus": "running",
                "nodeType": "Data",
                "subnet": "sb2 | KR-2 | Private"
            },
            {
                "computeInstanceName": "cluster-kvm000-do-24c7",
                "computeInstanceNo": 1008*****,
                "privateIp": "10.0.20.21",
                "serverStatus": "running",
                "nodeType": "Data",
                "subnet": "sb2 | KR-2 | Private"
            }
        ]
    },
    "requestId": "f4a41d71-****-****-****-753100085283"
}