클러스터 목록 조회

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

Cloud Data Streaming Service 클러스터 목록을 조회합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드	URI
POST	/api/v1/cluster/getClusterInfoList (수도권)
POST	/api/krs-v1/cluster/getClusterInfoList (남부권)

요청 헤더

Cloud Data Streaming Service API에서 공통으로 사용하는 헤더에 대한 정보는 Cloud Data Streaming Service 요청 헤더를 참조해 주십시오.

요청 바디

요청 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`inputText`	String	Optional	검색 키워드 클러스터 이름이 전체 또는 부분 일치하는 값 필터링
`vpcName`	String	Optional	VPC 이름 전체 일치하는 값만 필터링
`pageNo`	Integer	Optional	페이지 번호 1~N (기본값: 1)
`pageSize`	Integer	Optional	페이지 출력 수 1~N (기본값: 10)

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request POST 'https://clouddatastreamingservice.apigw.gov-ntruss.com/api/v1/cluster/getClusterInfoList' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
  "inputText" : "c",
  "vpcName": "test-vpc2",
  "pageNo" : 1,
  "pageSize" : 10
}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`code`	Integer	-	응답 코드
`message`	String	-	응답 메시지
`result`	Object	-	응답 결과
`result.currentPage`	Integer	-	현재 페이지 번호
`result.isFirst`	Boolean	-	첫 페이지 여부 `true` \| `false` `true`: 첫 페이지 `false`: 첫 페이지 아님
`result.isLast`	Boolean	-	마지막 페이지 여부 `true` \| `false` `true`: 마지막 페이지 `false`: 마지막 페이지 아님
`result.pageSize`	Integer	-	페이지 출력 수
`result.totalCount`	Integer	-	응답 결과 수
`result.totalPage`	Integer	-	전체 페이지 수
`result.allowedClusters`	Array	-	클러스터 목록
`result.disallowedClusters`	Array	-	권한 없는 클러스터 목록 서브 계정으로 호출 시 getClusterDetail 권한이 적용되지 않은 클러스터 표시
`requestId`	String	-	요청에 대한 아이디 UUID 형식

`allowedClusters`

allowedClusters에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`clusterName`	String	-	클러스터 이름
`brokerNodeType`	String	-	브로커 노드 타입
`brokerNodeProductName`	String	-	브로커 노드 서버 타입 이름
`brokerNodeCount`	Integer	-	브로커 노드 수
`brokerNodePublicEndpoint`	String	-	브로커 노드 Public Endpoint Public Endpoint가 활성화된 경우, 유효 값 표시
`isUsePublicEndpoint`	Boolean	-	브로커 노드 Public Endpoint 활성화 여부
`serverStatus`	String	-	서버 상태
`applicationVersion`	String	-	Cloud Data Streaming Service 버전
`kafkaVersion`	String	-	Kafka 버전
`cmakVersion`	String	-	CMAK 버전
`softwareProductName`	String	-	운영 체제 버전
`createDate`	Date	-	클러스터 생성 일시
`managerNodeType`	String	-	매니저 노드 타입
`managerNodeCount`	Integer	-	매니저 노드 수
`clusterPublicDomain`	String	-	관리 도구 접속용 Public 도메인
`isUsePublicDomain`	Boolean	-	Public 도메인 활성화 여부
`brokerStorageVolumeSize`	Long	-	브로커 노드 스토리지 용량(GB)
`managerNodeAccessControlGroupSequence`	Integer	-	매니저 노드 ACG 아이디
`managerNodeAccessControlGroupName`	String	-	매니저 노드 ACG 이름
`brokerNodeAccessControlGroupSequence`	Integer	-	브로커 노드 ACG 아이디
`brokerNodeAccessControlGroupName`	String	-	브로커 노드 ACG 이름
`kafkaBrokerPort`	Integer	-	브로커 노드 포트 번호
`kafkaBrokerTlsPort`	Integer	-	브로커 노드 TLS 포트 번호
`zookeeperPort`	Integer	-	주키퍼 노드 포트 번호
`cmakPort`	Integer	-	CMAK 접속 포트 번호
`serviceGroupInstanceNo`	String	-	클러스터 인스턴스 번호
`kafkaManagerUserName`	String	-	CMAK 접속 계정 아이디
`memberNo`	String	-	사용자의 네이버 클라우드 플랫폼 회원 번호
`vpcName`	String	-	VPC 이름
`vpcNo`	Integer	-	VPC 번호
`managerNodeSubnetName`	String	-	매니저 노드 Subnet 이름
`managerNodeSubnetNo`	Integer	-	매니저 노드 Subnet 번호
`brokerNodeSubnetName`	String	-	브로커 노드 Subnet 이름
`brokerNodeSubnetNo`	Integer	-	브로커 노드 Subnet 번호
`configGroupNo`	Integer	-	Config Group 번호
`configGroupName`	String	-	Config Group 이름

`disallowedClusters`

disallowedClusters에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`clusterName`	String	-	클러스터 이름
`serviceGroupInstanceNo`	String	-	클러스터 인스턴스 번호

응답 상태 코드

Cloud Data Streaming Service API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Cloud Data Streaming Service 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
    "code": 0,
    "message": "SUCCESS",
    "result": {
        "currentPage": 1,
        "isFirst": true,
        "isLast": true,
        "pageSize": 10,
        "totalCount": 2,
        "totalPage": 1,
        "allowedClusters": [
            {
                "clusterName": "cluster00",
                "brokerNodeType": "[STAND] 2vCPU, 8GB Mem",
                "brokerNodeProductName": "vCPU 2개, 메모리 8GB, [SSD]디스크 50GB",
                "brokerNodeCount": 3,
                "brokerNodePublicEndpoint": null,
                "isUsePublicEndpoint": false,
                "serverStatus": "running",
                "applicationVersion": "Kafka 3.9.0, CMAK 3.0.0.6",
                "kafkaVersion": "3.9.0",
                "cmakVersion": "3.0.0.6",
                "softwareProductName": "CentOS 7.8 (64-bit)",
                "createDate": "2025-04-16 09:37:24",
                "managerNodeType": "[STAND] 2vCPU, 8GB Mem",
                "managerNodeCount": 1,
                "clusterPublicDomain": "****************************************",
                "isUsePublicDomain": false,
                "brokerStorageVolumeSize": 322122547200,
                "managerNodeAccessControlGroupSequence": 5****,
                "managerNodeAccessControlGroupName": "cdss-m-1o2xag",
                "brokerNodeAccessControlGroupSequence": 5****,
                "brokerNodeAccessControlGroupName": "cdss-b-1o2xag",
                "kafkaBrokerPort": 9092,
                "kafkaBrokerTlsPort": 9093,
                "zookeeperPort": 2181,
                "cmakPort": 9000,
                "serviceGroupInstanceNo": "1009*****",
                "kafkaManagerUserName": "userid",
                "memberNo": "500****",
                "vpcName": "test-vpc2",
                "vpcNo": 4***,
                "managerNodeSubnetName": "sb2 | KR-2 | Private",
                "managerNodeSubnetNo": 33***,
                "brokerNodeSubnetName": "sb2 | KR-2 | Private",
                "brokerNodeSubnetNo": 33***,
                "configGroupNo": 3**,
                "configGroupName": "cg1"
            }
        ],
        "disallowedClusters": [
            {
                "clusterName": "cluster01",
                "serviceGroupInstanceNo": "1009*****"
            }
        ]
    },
    "requestId": "f6713e31-****-****-****-665ad3ebda9c"
}