클러스터 조회

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

Cloud Data Streaming Service 클러스터의 상세 정보를 조회합니다.

요청

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

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

요청 헤더

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

요청 경로 파라미터

요청 경로 파라미터에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`serviceGroupInstanceNo`	Integer	Required	클러스터 인스턴스 번호 클러스터 목록 조회 참조

요청 예시

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

curl --location --request POST 'https://clouddatastreamingservice.apigw.gov-ntruss.com/api/v1/cluster/getClusterInfoList/2434156' \
--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'

응답

응답 형식을 설명합니다.

응답 바디

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

필드	타입	필수 여부	설명
`code`	Integer	-	응답 코드
`message`	String	-	응답 메시지
`result`	Object	-	응답 결과
`result.clusterName`	String	-	클러스터 이름
`result.kafkaVersionCode`	String	-	Kafka 버전 코드
`result.kafkaManagerUserName`	String	-	CMAK 접속 계정 아이디
`result.softwareProductCode`	String	-	운영 체제 타입 코드
`result.vpcNo`	Integer	-	VPC 번호
`result.managerNodeProductCode`	String	-	매니저 노드 서버 타입 코드
`result.managerNodeSubnetNo`	Integer	-	매니저 노드 Subnet 번호
`result.brokerNodeProductCode`	String	-	브로커 노드 서버 타입 코드
`result.brokerNodeSubnetNo`	Integer	-	브로커 노드 Subnet 번호
`result.brokerNodeCount`	Integer	-	브로커 노드 수
`result.brokerNodeStorageSize`	Integer	-	브로커 노드별 스토리지 용량(GB)
`result.configGroupNo`	Integer	-	Config Group 번호
`result.status`	String	-	클러스터 상태
`requestId`	String	-	요청에 대한 아이디 UUID 형식

응답 상태 코드

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

응답 예시

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

{
    "code": 0,
    "message": "SUCCESS",
    "result": {
        "clusterName": "cluster00",
        "kafkaVersionCode": "3903006",
        "kafkaManagerUserName": "userid",
        "softwareProductCode": "SW.VCDSS.OS.LNX64.CNTOS.0708.B050",
        "vpcNo": 4***,
        "managerNodeProductCode": "SVR.VCDSS.STAND.C002.M008.NET.SSD.B050.G002",
        "managerNodeSubnetNo": 33***,
        "brokerNodeProductCode": "SVR.VCDSS.STAND.C002.M008.NET.SSD.B050.G002",
        "brokerNodeSubnetNo": 33***,
        "brokerNodeCount": 3,
        "brokerNodeStorageSize": 100,
        "configGroupNo": 3**,
        "status": "running"
    },
    "requestId": "a0d09046-****-****-****-207abe3cf0bc"
}