Get Search Engine Cluster Data node
    • PDF

    Get Search Engine Cluster Data node

    • PDF

    Article summary

    Can be used in a VPC environment.

    Description

    Check a list of Search Engine Cluster's nodes.

    Request

    Request URL

    GET https://vpcsearchengine.apigw.ntruss.com/api/v2/cluster/getClusterNodeList/{service-group-instance-no} [KR]
    GET https://vpcsearchengine.apigw.ntruss.com/api/sgn-v2/cluster/getClusterNodeList/{service-group-instance-no} [SGN]
    GET https://vpcsearchengine.apigw.ntruss.com/api/jpn-v2/cluster/getClusterNodeList/{service-group-instance-no} [JPN]
    

    Request headers

    HeaderDescription
    x-ncp-apigw-timestampThis is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC.
    If the time difference compared to the API Gateway server is more than 5 minutes, then the request is considered invalid.
    x-ncp-apigw-timestamp:{Timestamp}
    x-ncp-iam-access-keyThis is the Access Key ID value issued by the Naver Cloud Platform portal.
    x-ncp-iam-access-key:{Account Access Key}
    x-ncp-apigw-signature-v2This is the signature encrypted Access Key ID value and Secret Key.
    x-ncp-apigw-signature-v2:{API Gateway Signature}
    Content-TypeSpecifies the request body content type as application/json
    Content-Type: application/json

    Request parameters

    ParameterTypeRequired statusDescription
    serviceGroupInstanceNoStringYThis is the cluster no. to search the list of data nodes.

    Request example

    GET https://vpcsearchengine.apigw.ntruss.com/api/v2/cluster/getClusterNodeList/1484848
    HOST: vpcsearchengine.apigw.ntruss.com
    Content-Type: application/json
    x-ncp-apigw-signature-v2: zq0FrtlU8JZJi9esTK31bCQUNG3H+jo4CMjMkJDoWSc=
    x-ncp-apigw-timestamp: 1593848345548
    x-ncp-iam-access-key: 7fIvgFY428mtY6sY8maw
    
    curl -X GET "https://vpcsearchengine.apigw.ntruss.com/api/v2/cluster/getClusterNodeList/1484848" \
    -H "accept: application/json" \
    -H "Content-Type: application/json" \
    -H "x-ncp-iam-access-key: 7fIvgFY428mtY6sY8maw" \
    -H "x-ncp-apigw-timestamp: 1601971222179" \
    -H "x-ncp-apigw-signature-v2: zrCelnR48AADdK/uh6Xe3yy468i8KpQoewYHUmeqYh4="
    

    Response parameters

    public class GetClusterDataNodeList {
        List<GetDataNodeListResponseDetailVo> computeList;
        Integer contractNo;
        DateTimeVo createdDate;
        String productCode;
        Integer regionNo;
        Integer serviceGroupInstanceNo;
        String serviceGroupInstanceTypeCode;
        String serviceGroupName;
        String statusCode;
        Integer vpcNo;
    }
    
    public class GetDataNodeListResponseDetailVo {
        Integer computeInstanceNo;
        String computeInstanceProductCode;
        String computeInstanceStatus;
        Integer cpuCount;
        DateTimeVo createdYmdt;
        String hostName;
        String macAddress;
        Long memorySize;
        String nodeRoleCode;
        DateTimeVo operationYmdt;
        String osInfo;
        String privateIp;
        String regionCode;
        String regionName;
        String regionNo;
        Boolean selfManaged;
        Integer serviceGroupInstanceNo;
        String uuid;
        String vpcName;
        Integer vpcNo;
        String subnetName;
        Integer subnetNo;
        String zoneName;
        Integer zoneNo;
    }
    
    public class DateTimeVo {
        @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd", timezone = "Asia/Seoul")
        Date formattedDate;
        @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd HH:mm:ss SSSSSS", timezone = "Asia/Seoul")
        Date formattedDateTime;
        Long utc;
    }
    

    Field

    Parameter NameTypeDescription
    computeListList<GetDataNodeListResponseDetailVo>List of data nodes
    contractNoIntegerContract no.
    createdDateDateTimeVoCluster creation date
    productCodeStringOS product code
    regionNoIntegerNo. of a region where the server is located
    serviceGroupInstanceNoIntegerCluster instance no.
    serviceGroupInstanceTypeCodeStringCluster instance type
    serviceGroupNameStringCluster name
    statusCodeStringInstance status code
    vpcNoIntegerNo. of a VPC where the server is located
    computeInstanceNoIntegerServer instance number
    computeInstanceProductCodeStringServer instance's HW product code
    computeInstanceStatusStringServer instance status code
    cpuCountIntegerNumber of vCPUs
    createdYmdtDateTimeVoServer creation date
    hostNameStringServer instance name
    macAddressStringServer instance MAC address
    memorySizeLongMemory size in Bytes
    nodeRoleCodeStringServer role code
    operationYmdtDateTimeVoServer operation time
    osInfoStringOS information
    privateIpStringPrivate IP address
    regionCodeStringCode of the region where the server is located
    regionNameStringName of the region where the server is located
    regionNoStringNo. of the region where the server is located
    selfManagedBooleanWhether the Console Server tab is displayed
    serviceGroupInstanceNoIntegerCluster instance no.
    uuidStringServer instance unique ID
    vpcNameStringName of the VPC where the server is located
    vpcNoIntegerNo. of the VPC where the server is located
    subnetNameStringName of the subnet where the server is located
    subnetNoIntegerNo. of the subnet where the server is located
    zoneNameStringName of the zone where the server is located
    zoneNoIntegerNo. of the zone where the server is located
    formattedDateDateCreation date
    formattedDateTimeDateCreation date and time
    utcLongConvert the UTC time created into milliseconds

    Response example

    {
      "code": 0,
      "message": "SUCCESS",
      "result": {
        "contractNo": 505151,
        "createdDate": {
          "formattedDate": "2020-10-06",
          "formattedDateTime": "2020-10-06 18:06:40 000073",
          "utc": 1601975200073
        },
        "productCode": "SW.VELST.OS.LNX64.CNTOS.0703.B050",
        "regionNo": 1,
        "serviceGroupInstanceNo": 1484848,
        "serviceGroupInstanceTypeCode": "VELST",
        "serviceGroupName": "openapitest11",
        "statusCode": "CREAT",
        "vpcNo": 36752,
        "computeList": [
          {
            "computeInstanceNo": 1484849,
            "computeInstanceProductCode": "SVR.VELST.STAND.C002.M004.NET.SSD.B050.G001",
            "computeInstanceStatus": "running",
            "cpuCount": 2,
            "createdYmdt": {
              "formattedDate": "2020-10-06",
              "formattedDateTime": "2020-10-06 18:06:40 000999",
              "utc": 1601975200999
            },
            "hostName": "openapitest11-m-9wy",
            "macAddress": "F2:20:EF:7A:A6:D3",
            "memorySize": 4294967296,
            "nodeRoleCode": "M",
            "operationYmdt": {
              "formattedDate": "2020-10-06",
              "formattedDateTime": "2020-10-06 18:09:41 000867",
              "utc": 1601975381867
            },
            "osInfo": "CentOS 7.3 (64-bit)",
            "privateIp": "10.0.1.14",
            "regionCode": "KR",
            "regionName": "Korea",
            "regionNo": "11",
            "selfManaged": false,
            "serviceGroupInstanceNo": 1484848,
            "uuid": "1db365ff-9ac8-d7fa-dcb3-437c2b9cf43a",
            "vpcName": "test",
            "vpcNo": 36752,
            "subnetNo": 22630,
            "subnetName": "testpri | KR-1 | Private",
            "zoneName": "KR-1",
            "zoneNo": 2
          },
          {
            "computeInstanceNo": 1484852,
            "computeInstanceProductCode": "SVR.VELST.STAND.C002.M004.NET.SSD.B050.G001",
            "computeInstanceStatus": "running",
            "cpuCount": 2,
            "createdYmdt": {
              "formattedDate": "2020-10-06",
              "formattedDateTime": "2020-10-06 18:06:41 000175",
              "utc": 1601975201175
            },
            "hostName": "openapitest11-m-9wz",
            "macAddress": "F2:20:EF:13:02:04",
            "memorySize": 4294967296,
            "nodeRoleCode": "M",
            "operationYmdt": {
              "formattedDate": "2020-10-06",
              "formattedDateTime": "2020-10-06 18:09:44 000829",
              "utc": 1601975384829
            },
            "osInfo": "CentOS 7.3 (64-bit)",
            "privateIp": "10.0.1.15",
            "regionCode": "KR",
            "regionName": "Korea",
            "regionNo": "1",
            "selfManaged": false,
            "serviceGroupInstanceNo": 1484848,
            "uuid": "835f6c82-a4f4-c85a-21fe-f7b86a6b33e0",
            "vpcName": "test",
            "vpcNo": 36752,
            "subnetNo": 22630,
            "subnetName": "testpri | KR-1 | Private",
            "zoneName": "KR-1",
            "zoneNo": 2
          },
          {
            "computeInstanceNo": 1484855,
            "computeInstanceProductCode": "SVR.VELST.STAND.C002.M004.NET.SSD.B050.G001",
            "computeInstanceStatus": "running",
            "cpuCount": 2,
            "createdYmdt": {
              "formattedDate": "2020-10-06",
              "formattedDateTime": "2020-10-06 18:06:41 000384",
              "utc": 1601975201384
            },
            "hostName": "openapitest11-d-9x0",
            "macAddress": "F2:20:EF:F9:6A:6D",
            "memorySize": 4294967296,
            "nodeRoleCode": "D",
            "operationYmdt": {
              "formattedDate": "2020-10-06",
              "formattedDateTime": "2020-10-06 18:09:49 000782",
              "utc": 1601975389782
            },
            "osInfo": "CentOS 7.3 (64-bit)",
            "privateIp": "10.0.1.16",
            "regionCode": "KR",
            "regionName": "Korea",
            "regionNo": "1",
            "selfManaged": false,
            "serviceGroupInstanceNo": 1484848,
            "uuid": "50551c12-d482-6401-f120-b2175a329a19",
            "vpcName": "test",
            "vpcNo": 36752,
            "subnetNo": 22630,
            "subnetName": "testpri | KR-1 | Private",
            "zoneName": "KR-1",
            "zoneNo": 2
          },
          {
            "computeInstanceNo": 1484859,
            "computeInstanceProductCode": "SVR.VELST.STAND.C002.M004.NET.SSD.B050.G001",
            "computeInstanceStatus": "running",
            "cpuCount": 2,
            "createdYmdt": {
              "formattedDate": "2020-10-06",
              "formattedDateTime": "2020-10-06 18:06:41 000563",
              "utc": 1601975201563
            },
            "hostName": "openapitest11-d-9x1",
            "macAddress": "F2:20:EF:17:1C:F6",
            "memorySize": 4294967296,
            "nodeRoleCode": "D",
            "operationYmdt": {
              "formattedDate": "2020-10-06",
              "formattedDateTime": "2020-10-06 18:09:51 000143",
              "utc": 1601975391143
            },
            "osInfo": "CentOS 7.3 (64-bit)",
            "privateIp": "10.0.1.17",
            "regionCode": "KR",
            "regionName": "Korea",
            "regionNo": "1",
            "selfManaged": false,
            "serviceGroupInstanceNo": 1484848,
            "uuid": "f5633747-b6b1-5452-ddda-940c99b0c9c8",
            "vpcName": "test",
            "vpcNo": 36752,
            "subnetNo": 22630,
            "subnetName": "testpri | KR-1 | Private",
            "zoneName": "KR-1",
            "zoneNo": 2
          },
          {
            "computeInstanceNo": 1484863,
            "computeInstanceProductCode": "SVR.VELST.STAND.C002.M004.NET.SSD.B050.G001",
            "computeInstanceStatus": "running",
            "cpuCount": 2,
            "createdYmdt": {
              "formattedDate": "2020-10-06",
              "formattedDateTime": "2020-10-06 18:06:41 000737",
              "utc": 1601975201737
            },
            "hostName": "openapitest11-d-9x2",
            "macAddress": "F2:20:EF:03:FA:5E",
            "memorySize": 4294967296,
            "nodeRoleCode": "D",
            "operationYmdt": {
              "formattedDate": "2020-10-06",
              "formattedDateTime": "2020-10-06 18:09:46 000197",
              "utc": 1601975386197
            },
            "osInfo": "CentOS 7.3 (64-bit)",
            "privateIp": "10.0.1.18",
            "regionCode": "KR",
            "regionName": "Korea",
            "regionNo": "1",
            "selfManaged": false,
            "serviceGroupInstanceNo": 1484848,
            "uuid": "1e6d6df9-f140-2a9f-b0cf-74479807ff26",
            "vpcName": "test",
            "vpcNo": 36752,
            "subnetNo": 22630,
            "subnetName": "testpri | KR-1 | Private",
            "zoneName": "KR-1",
            "zoneNo": 2
          }
        ]
      },
      "requestId": "985024f0-4e51-4105-a555-d9f62d43fede"
    }
    

    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.