Cloud Data Streaming Service Cluster 목록 조회

Prev Next

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

설명

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

요청

요청 URL

POST https://clouddatastreamingservice.apigw.gov-ntruss.com/api/v1/cluster/getClusterInfoList?pageNo={pageNo}&pageSize={pageSize} [수도권]
POST https://clouddatastreamingservice.apigw.gov-ntruss.com/api/krs-v1/cluster/getClusterInfoList?pageNo={pageNo}&pageSize={pageSize} [남부권]

요청 헤더

헤더명 설명
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-v2 Access Key ID 값과 Secret Key로 암호화한 서명
x-ncp-apigw-signature-v2:{API Gateway Signature}
Content-Type Request body content type을 application/json으로 지정
Content-Type: application/json

요청 파라미터

파라미터 타입 필수 여부 설명
inputText String N 조회할 Cluster의 이름
vpcName String N 해당 VPC를 사용하고 있는 Cluster 조회
pageNo Integer N - 페이지 번호
Default : 1
ex) 1, 2
pageSize Integer N - 페이지 사이즈
Defatlt : 10
ex) 10, 20

요청 예시

POST https://clouddatastreamingservice.apigw.gov-ntruss.com/api/v1/cluster/getClusterInfoList
HOST: clouddatastreamingservice.apigw.gov-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
}
curl -X POST "https://clouddatastreamingservice.apigw.gov-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
 }'

응답 파라미터

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;
}

필드

파라미터명 타입 설명
serviceGroupInstanceNo String 생성된 Cluster의 serviceGroupInstanceNo
allowedClusters List<AllowedClusterInfo> 클러스터 목록
disallowedClusters List<DisallowedClusterInfo> Subaccount로 호출 시, getClusterDetail 권한이 없는 Cluster 목록
currentPage Integer 현재 page
isFirst Boolean first page 여부
isLast Boolean last page 여부
pageSize Integer page 크기
totalCount Long Cluster의 총 리스트 개수
totalPage Integer 총 page 수
clusterName String 클러스터 이름
brokerNodeType String 브로커 노드 타입
brokerNodeProductName String 브로커 노드 타입 이름
brokerNodeCount Integer 브로커 노드 개수
applicationVersion String Cloud Data Streaming Service 버전
cmakVersion String CMAK 버전
kafkaVersion String Kafka 버전
softwareProductName String OS 상품 이름
createDate Date 생성 일자
managerNodeType String 매니저 노드 타입
managerNodeCount Integer 매니저 노드 개수
clusterPublicDomain String 클러스터 접속 Domain
isUsePublicDomain Boolean Public Domain 활성화 여부
brokerStorageVolumeSize Long 브로커 노드 Storage 크기
managerNodeAccessControlGroupSequence Integer 매니저 노드 ACG 번호
managerNodeAccessControlGroupName String 매니저 노드 ACG 이름
brokerNodeAccessControlGroupSequence Integer 브로커 노드 ACG 번호
brokerNodeAccessControlGroupName String 브로커 노드 ACG 이름
kafkaBrokerPort String 브로커 노드 Port
kafkaBrokerTlsPort String 브로커 노드 TLS Port
zookeeperPort String 주키퍼 노드 Port
cmakPort String CMAK 접속 Port
serviceGroupInstanceNo String Cluster 인스턴스 번호
kafkaManagerUserName String CMAK 접속 아이디
memberNo String 고객 번호
vpcName String 서버가 위치해 있는 VPC 이름
vpcNo Integer 서버가 위치해 있는 VPC 번호
managerNodeSubnetName String 매니저 노드가 위치해 있는 Subnet 이름
managerNodeSubnetNo Integer 매니저 노드가 위치해 있는 Subnet 번호
brokerNodeSubnetName String 브로커 노드가 위치해 있는 Subnet 이름
brokerNodeSubnetNo Integer 브로커 노드가 위치해 있는 Subnet 이름
conifgGroupNo Integer ConfigGroup의 번호
conifgGroupName String ConfigGroup의 이름

응답 예시

{
  "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"
}