MENU
      Cloud Data Streaming Service Cluster 목록 조회

        Cloud Data Streaming Service Cluster 목록 조회


        기사 요약

        VPC 환경에서 이용 가능합니다.

        설명

        Cloud Data Streaming Service Cluster 목록을 조회합니다.

        요청

        요청 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

        요청 헤더

        헤더명설명
        x-ncp-apigw-timestamp- 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타냄
        - API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주
        x-ncp-apigw-timestamp:{Timestamp}
        x-ncp-iam-access-key네이버 클라우드 플랫폼 포털에서 발급받은 Access Key ID 값
        x-ncp-iam-access-key:{Account Access Key}
        x-ncp-apigw-signature-v2Access Key ID 값과 Secret Key로 암호화한 서명
        x-ncp-apigw-signature-v2:{API Gateway Signature}
        Content-TypeRequest body content type을 application/json으로 지정
        Content-Type: application/json

        요청 파라미터

        파라미터타입필수 여부설명
        inputTextStringN조회할 Cluster의 이름
        vpcNameStringN해당 VPC를 사용하고 있는 Cluster 조회
        pageNoIntegerN페이지 번호 Default : 1
        - <예시> 1, 2
        pageSizeIntegerN페이지 사이즈 Defatlt : 10
        - <예시> 10, 20

        요청 예시

        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

        응답 파라미터

        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

        필드

        파라미터명타입설명
        serviceGroupInstanceNoString생성된 Cluster의 serviceGroupInstanceNo
        allowedClustersList<AllowedClusterInfo>클러스터 목록
        disallowedClustersList<DisallowedClusterInfo>Subaccount로 호출 시 getClusterDetail 권한이 없는 Cluster 목록
        currentPageInteger현재 page
        isFirstBooleanfirst page 여부
        isLastBooleanlast page 여부
        pageSizeIntegerpage 크기
        totalCountLongCluster의 총 리스트 개수
        totalPageInteger총 page 수
        clusterNameString클러스터 이름
        brokerNodeTypeString브로커 노드 타입
        brokerNodeProductNameString브로커 노드 타입 이름
        brokerNodeCountInteger브로커 노드 개수
        applicationVersionStringCloud Data Streaming Service 버전
        cmakVersionStringCMAK 버전
        kafkaVersionStringKafka 버전
        softwareProductNameStringOS 상품 이름
        createDateDate생성 일자
        managerNodeTypeString매니저 노드 타입
        managerNodeCountInteger매니저 노드 개수
        clusterPublicDomainString클러스터 접속 Domain
        isUsePublicDomainBooleanPublic Domain 활성화 여부
        brokerStorageVolumeSizeLong브로커 노드 Storage 크기
        managerNodeAccessControlGroupSequenceInteger매니저 노드 ACG 번호
        managerNodeAccessControlGroupNameString매니저 노드 ACG 이름
        brokerNodeAccessControlGroupSequenceInteger브로커 노드 ACG 번호
        brokerNodeAccessControlGroupNameString브로커 노드 ACG 이름
        kafkaBrokerPortString브로커 노드 Port
        kafkaBrokerTlsPortString브로커 노드 TLS Port
        zookeeperPortString주키퍼 노드 Port
        cmakPortStringCMAK 접속 Port
        serviceGroupInstanceNoStringCluster 인스턴스 번호
        kafkaManagerUserNameStringCMAK 접속 아이디
        memberNoString고객 번호
        vpcNameString서버가 위치해 있는 VPC 이름
        vpcNoInteger서버가 위치해 있는 VPC 번호
        managerNodeSubnetNameString매니저 노드가 위치해 있는 Subnet 이름
        managerNodeSubnetNoInteger매니저 노드가 위치해 있는 Subnet 번호
        brokerNodeSubnetNameString브로커 노드가 위치해 있는 Subnet 이름
        brokerNodeSubnetNoInteger브로커 노드가 위치해 있는 Subnet 이름
        conifgGroupNoIntegerConfigGroup의 번호
        conifgGroupNameStringConfigGroup의 이름

        응답 예시

        {
          "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": "vCPU 2개, 메모리 4GB, [SSD]디스크 50GB",
                "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

        이 문서가 도움이 되었습니까?

        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.