MENU
      Search Cloud Data Streaming Service Cluster list

        Search Cloud Data Streaming Service Cluster list


        Article summary

        Can be used in a VPC environment.

        Description

        Search a list of Cloud Data Streaming Service Clusters.

        Request

        Request URL

        POST https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/getClusterInfoList?pageNo={pageNo}&pageSize={pageSize} [KR]
        POST https://clouddatastreamingservice.apigw.ntruss.com/api/sgn-v1/cluster/getClusterInfoList?pageNo={pageNo}&pageSize={pageSize} [SGN]
        POST https://clouddatastreamingservice.apigw.ntruss.com/api/jpn-v1/cluster/getClusterInfoList?pageNo={pageNo}&pageSize={pageSize} [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
        inputTextStringNThis is the cluster name to search.
        vpcNameStringNSearch the cluster using the VPC.
        pageNoIntegerNThis is the page number. Default : 1
        ex) 1, 2
        pageSizeIntegerNThis is the page size. Defatlt : 10
        ex) 10, 20

        Request example

        POST https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/getClusterInfoList
        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
        
        {
          "inputText" : "open",
          "vpcName": "test",
          "pageNo" : 1,
          "pageSize" : 10
        }
        HTTP
        curl -X POST "https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/getClusterInfoList?pageNo=1&pageSize=10 \
        -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=" \
        -d \
        '{
           "inputText" : "open",
           "vpcName": "test",
           "pageNo" : 1,
           "pageSize" : 10
         }'
        Bash

        Response parameters

        public class GetClusterInfoListResponseVo {
            private List<AllowedClusterInfo> allowedClusters;
            private List<DisallowedClusterInfo> disallowedClusters;
            private Integer currentPage;
            private Boolean isFirst;
            private Boolean isLast;
            private Integer pageSize;
            private Long totalCount;
            private Integer totalPage;
        }
        
        public class AllowedClusterInfo {
            private String clusterName;
            private String brokerNodeType;
            private String brokerNodeProductName;
            private Integer brokerNodeCount;
            private String applicationVersion;
            private String kafkaVersion;
            private String cmakVersion;
            private String softwareProductName;
            private Date createDate;
            private String managerNodeType;
            private Integer managerNodeCount;
            private String clusterPublicDomain;
            private Boolean isUsePublicDomain;
            private Long dataStorageVolumeSize;
            private Integer managerNodeAccessControlGroupSequence;
            private String managerNodeAccessControlGroupName;
            private Integer brokerNodeAccessControlGroupSequence;
            private String brokerNodeAccessControlGroupName;
            private Integer kafkaBrokerPort;
            private Integer kafkaBrokerTlsPort;
            private Integer zookeeperPort;
            private Integer cmakPort;
            private String serviceGroupInstanceNo;
            private String kafkaManagerUserName;
            private String memberNo;
            private String vpcName;
            private Integer vpcNo;
            private String managerNodeSubnetName;
            private Integer managerNodeSubnetNo;
            private String brokerNodeSubnetNo;
            private Integer brokerNodeSubnetNo;
            private Integer configGroupNo;
            private String configGroupName;
        }
        
        public class DisallowedClusterInfo {
            private String clusterName;
            private String serviceGroupInstanceNo;
        }
        Java

        Field

        Parameter nameTypeDescription
        serviceGroupInstanceNoStringserviceGroupInstanceNo of the cluster created
        allowedClustersListCluster list
        disallowedClustersListList of clusters without getClusterDetail permissions when calling with Subaccount
        currentPageIntegerCurrent page
        isFirstBooleanFirst page status
        isLastBooleanLast page status
        pageSizeIntegerPage size
        totalCountLongTotal number of the cluster's lists
        totalPageIntegerTotal page number
        clusterNameStringCluster name
        brokerNodeTypeStringBroker node type
        brokerNodeProductNameStringBroker node type name
        brokerNodeCountIntegerNumber of broker nodes
        applicationVersionStringCloud Data Streaming Service version
        cmakVersionStringCMAK version
        kafkaVersionStringKafka version
        softwareProductNameStringOS product name
        createDateDateCreated date
        managerNodeTypeStringManager node type
        managerNodeCountIntegerNumber of manager nodes
        clusterPublicDomainStringCluster access domain
        isUsePublicDomainBooleanWhether to use Public Domain
        brokerStorageVolumeSizeLongBroker node storage size
        managerNodeAccessControlGroupSequenceIntegerNumber of the manager node ACG
        managerNodeAccessControlGroupNameStringManager node ACG name
        brokerNodeAccessControlGroupSequenceIntegerNumber of the broker node ACG
        brokerNodeAccessControlGroupNameStringName of the broker node ACG
        kafkaBrokerPortStringBroker node port
        kafkaBrokerTlsPortStringBroker node TLS port
        zookeeperPortStringZooKeeper node port
        cmakPortStringCMAK connection port
        serviceGroupInstanceNoStringCluster instance number
        kafkaManagerUserNameStringCMAK connection ID
        memberNoStringCustomer number
        vpcNameStringName of the VPC where the server is located
        vpcNoIntegerNumber of the VPC where the server is located
        managerNodeSubnetNameStringName of the subnet where the manager node is located
        managerNodeSubnetNoIntegerNumber of the subnet where the manager node is located
        brokerNodeSubnetNameStringName of the subnet where the broker node is located
        brokerNodeSubnetNoIntegerNumber of the subnet where the broker node is located
        conifgGroupNoIntegerNumber of the ConfigGroup
        conifgGroupNameStringName of the ConfigGroup

        Response example

        {
          "code": 0,
          "message": "SUCCESS",
          "result": {
            "currentPage": 1,
            "isFirst": true,
            "isLast": true,
            "pageSize": 10,
            "totalCount": 1,
            "totalPage": 1,
            "allowedClusters": [
              {
                "clusterName": "tesss",
                "brokerNodeType": "2vCPU, 4GB Mem",
                "brokerNodeProductName": "2 vCPUs, 4 GB memory, 50 GB [SSD] disk",
                "brokerNodeCount": 4,
                "serverStatus": "running",
                "applicationVersion": "Kafka 2.4.0, CMAK 3.0.0.5",
                "kafkaVersion": "2.4.0",
                "cmakVersion": "3.0.0.5",
                "softwareProductName": "CentOS 7.3 (64-bit)",
                "createDate": "2020-10-26 11:54:35",
                "managerNodeType": "2vCPU, 4GB Mem",
                "managerNodeCount": 1,
                "clusterPublicDomain": "tesss-1524372151.kr.cdss.beta.naverncp.com",
                "isUsePublicDomain": true,
                "brokerStorageVolumeSize": 429496729600,
                "managerNodeAccessControlGroupSequence": 3751,
                "managerNodeAccessControlGroupName": "cdss-m-wd2v",
                "brokerNodeAccessControlGroupSequence": 3750,
                "brokerNodeAccessControlGroupName": "cdss-b-wd2v",
                "kafkaBrokerPort": 9092,
                "kafkaBrokerTlsPort": 9093,
                "zookeeperPort": 2181,
                "cmakPort": 9000,
                "serviceGroupInstanceNo": "1509943",
                "kafkaManagerUserName": "yea",
                "memberNo": "703",
                "vpcName": "clean",
                "vpcNo": 1236,
                "managerNodeSubnetName": "clean-pub | KR-1",
                "managerNodeSubnetNo": 1300,
                "brokerNodeSubnetName": "clean-private | KR-1",
                "brokerNodeSubnetNo": 1301,
                "configGroupNo": 127,
                "configGroupName": "test-config"
              }
            ],
            "disallowedClusters": []
          },
          "requestId": "e465729c-aff5-4aaf-8981-ed8c87dcd2ca"
        }
        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.