MENU
      Search Cloud Data Streaming Service Cluster node

        Search Cloud Data Streaming Service Cluster node


        Article summary

        Can be used in a VPC environment.

        Description

        Search a Cloud Data Streaming Service Cluster's node.

        Request

        Request URL

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

        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.
        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 number to search the list of broker nodes.

        Request example

        GET https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/getClusterNodeList/1484848
        HOST: clouddatastreamingservice.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
        HTTP
        curl -X GET "https://clouddatastreamingservice.apigw.ntruss.com/api/v1/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="
        Bash

        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 {
            Date formattedDate;
            Date formattedDateTime;
            Long utc;
        }
        Java

        Field

        Parameter nameTypeDescription
        computeListListList of data nodes
        contractNoIntegerContract number
        createdDateDateTimeVoCluster creation date
        productCodeStringOS product code
        regionNoIntegerNumber of a region where the server is located
        serviceGroupInstanceNoIntegerCluster instance number
        serviceGroupInstanceTypeCodeStringCluster instance type
        serviceGroupNameStringCluster name
        statusCodeStringInstance status code
        vpcNoIntegerNumber of a VPC where the server is located
        computeInstanceNoIntegerServer instance number
        computeInstanceProductCodeStringServer instance 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 rule 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
        regionNoStringNumber of the region where the server is located
        selfManagedBooleanConsole Server tab exposure status
        serviceGroupInstanceNoIntegerCluster instance number
        uuidStringServer instance unique ID
        vpcNameStringName of the VPC where the server is located
        vpcNoIntegerNumber of the VPC where the server is located
        subnetNameStringName of the subnet where the server is located
        subnetNoIntegerNumber of the subnet where the server is located
        zoneNameStringName of the zone where the server is located
        zoneNoIntegerNumber 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": 525810,
            "createdDate": {
              "formattedDate": "2020-10-26",
              "formattedDateTime": "2020-10-26 11:54:35 000861",
              "utc": 1603680875861
            },
            "productCode": "SW.VCDSS.OS.LNX64.CNTOS.0703.B050",
            "regionNo": 1,
            "serviceGroupInstanceNo": 1509943,
            "serviceGroupInstanceTypeCode": "VCDSS",
            "serviceGroupName": "tesss",
            "statusCode": "CREAT",
            "vpcNo": 1236,
            "computeList": [
              {
                "computeInstanceNo": 1509944,
                "computeInstanceProductCode": "SVR.VCDSS.HICPU.C002.M004.NET.SSD.B050.G002",
                "computeInstanceStatus": "running",
                "cpuCount": 2,
                "createdYmdt": {
                  "formattedDate": "2020-10-26",
                  "formattedDateTime": "2020-10-26 11:54:36 000998",
                  "utc": 1603680876998
                },
                "hostName": "tesss-m-4hp",
                "macAddress": "F2:20:AF:F6:9F:BC",
                "memorySize": 4294967296,
                "nodeRoleCode": "M",
                "operationYmdt": {
                  "formattedDate": "2020-10-26",
                  "formattedDateTime": "2020-10-26 11:57:10 000490",
                  "utc": 1603681030490
                },
                "osInfo": "CentOS 7.3 (64-bit)",
                "privateIp": "10.0.0.12",
                "regionCode": "KR",
                "regionName": "Korea",
                "regionNo": "1",
                "selfManaged": false,
                "serviceGroupInstanceNo": 1509943,
                "uuid": "12a8d0f1-fda4-3959-ccf1-691e25e9ad2e",
                "vpcName": "clean",
                "vpcNo": 1236,
                "subnetNo": 1300,
                "subnetName": "clean-pub | KR-1",
                "zoneName": "KR-1",
                "zoneNo": 2
              },
              {
                "computeInstanceNo": 1509947,
                "computeInstanceProductCode": "SVR.VCDSS.HICPU.C002.M004.NET.SSD.B050.G002",
                "computeInstanceStatus": "running",
                "cpuCount": 2,
                "createdYmdt": {
                  "formattedDate": "2020-10-26",
                  "formattedDateTime": "2020-10-26 11:54:37 000208",
                  "utc": 1603680877208
                },
                "hostName": "tesss-b-4hq",
                "macAddress": "F2:20:AF:F6:AB:08",
                "memorySize": 4294967296,
                "nodeRoleCode": "B",
                "operationYmdt": {
                  "formattedDate": "2020-10-26",
                  "formattedDateTime": "2020-10-26 11:57:03 000913",
                  "utc": 1603681023913
                },
                "osInfo": "CentOS 7.3 (64-bit)",
                "privateIp": "10.0.1.29",
                "regionCode": "KR",
                "regionName": "Korea",
                "regionNo": "1",
                "selfManaged": false,
                "serviceGroupInstanceNo": 1509943,
                "uuid": "81f18061-de79-b34e-b99d-8719d0446c76",
                "vpcName": "clean",
                "vpcNo": 1236,
                "subnetNo": 1301,
                "subnetName": "clean-private | KR-1",
                "zoneName": "KR-1",
                "zoneNo": 2
              },
              {
                "computeInstanceNo": 1509951,
                "computeInstanceProductCode": "SVR.VCDSS.HICPU.C002.M004.NET.SSD.B050.G002",
                "computeInstanceStatus": "running",
                "cpuCount": 2,
                "createdYmdt": {
                  "formattedDate": "2020-10-26",
                  "formattedDateTime": "2020-10-26 11:54:37 000355",
                  "utc": 1603680877355
                },
                "hostName": "tesss-b-4hr",
                "macAddress": "F2:20:AF:F6:B1:36",
                "memorySize": 4294967296,
                "nodeRoleCode": "B",
                "operationYmdt": {
                  "formattedDate": "2020-10-26",
                  "formattedDateTime": "2020-10-26 11:57:32 000832",
                  "utc": 1603681052832
                },
                "osInfo": "CentOS 7.3 (64-bit)",
                "privateIp": "10.0.1.30",
                "regionCode": "KR",
                "regionName": "Korea",
                "regionNo": "1",
                "selfManaged": false,
                "serviceGroupInstanceNo": 1509943,
                "uuid": "2a9bfb2b-e3f1-51cf-0194-f16bc869ca00",
                "vpcName": "clean",
                "vpcNo": 1236,
                "subnetNo": 1301,
                "subnetName": "clean-private | KR-1",
                "zoneName": "KR-1",
                "zoneNo": 2
              },
              {
                "computeInstanceNo": 1509955,
                "computeInstanceProductCode": "SVR.VCDSS.HICPU.C002.M004.NET.SSD.B050.G002",
                "computeInstanceStatus": "running",
                "cpuCount": 2,
                "createdYmdt": {
                  "formattedDate": "2020-10-26",
                  "formattedDateTime": "2020-10-26 11:54:37 000486",
                  "utc": 1603680877486
                },
                "hostName": "tesss-b-4hs",
                "macAddress": "F2:20:AF:F6:BF:D3",
                "memorySize": 4294967296,
                "nodeRoleCode": "B",
                "operationYmdt": {
                  "formattedDate": "2020-10-26",
                  "formattedDateTime": "2020-10-26 11:57:44 000697",
                  "utc": 1603681064697
                },
                "osInfo": "CentOS 7.3 (64-bit)",
                "privateIp": "10.0.1.31",
                "regionCode": "KR",
                "regionName": "Korea",
                "regionNo": "1",
                "selfManaged": false,
                "serviceGroupInstanceNo": 1509943,
                "uuid": "ea1030f6-3a37-0ef8-6b0b-426d759d69ff",
                "vpcName": "clean",
                "vpcNo": 1236,
                "subnetNo": 1301,
                "subnetName": "clean-private | KR-1",
                "zoneName": "KR-1",
                "zoneNo": 2
              },
              {
                "computeInstanceNo": 1509998,
                "computeInstanceProductCode": "SVR.VCDSS.HICPU.C002.M004.NET.SSD.B050.G002",
                "computeInstanceStatus": "running",
                "cpuCount": 2,
                "createdYmdt": {
                  "formattedDate": "2020-10-26",
                  "formattedDateTime": "2020-10-26 14:06:37 000001",
                  "utc": 1603688797001
                },
                "hostName": "tesss-b-4ht",
                "macAddress": "F2:20:AF:F6:C9:E6",
                "memorySize": 4294967296,
                "nodeRoleCode": "B",
                "operationYmdt": {
                  "formattedDate": "2020-10-26",
                  "formattedDateTime": "2020-10-26 14:09:08 000830",
                  "utc": 1603688948830
                },
                "osInfo": "CentOS 7.3 (64-bit)",
                "privateIp": "10.0.1.32",
                "regionCode": "KR",
                "regionName": "Korea",
                "regionNo": "1",
                "selfManaged": false,
                "serviceGroupInstanceNo": 1509943,
                "uuid": "26ec215d-9673-3c90-1dec-7f14c956b880",
                "vpcName": "clean",
                "vpcNo": 1236,
                "subnetNo": 1301,
                "subnetName": "clean-private | KR-1",
                "zoneName": "KR-1",
                "zoneNo": 2
              }
            ]
          },
          "requestId": "026d8c36-5af9-4998-8d43-dfd1111865ed"
        }
        JSON

        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.