Cloud Data Streaming Service Cluster 단건 조회

인쇄
공유
PDF

기사 요약

이 요약이 도움이 되었나요?

의견을 보내 주셔서 감사합니다.

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

설명

Cloud Data Streaming Service에 존재하는 Cluster를 조회합니다.

요청

요청 URL

POST https://clouddatastreamingservice.apigw.gov-ntruss.com/api/v1/cluster/getClusterInfoList/{service-group-instance-no} [수도권]
POST https://clouddatastreamingservice.apigw.gov-ntruss.com/api/krs-v1/cluster/getClusterInfoList/{service-group-instance-no} [남부권]

요청 헤더

헤더명	설명
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`

요청 파라미터

파라미터	타입	필수 여부	설명
serviceGroupInstanceNo	String	Y	브로커 노드 목록을 조회할 Cluster 번호

요청 예시

POST https://clouddatastreamingservice.apigw.gov-ntruss.com/api/v1/cluster/getClusterInfoList/{service-group-instance-no}
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

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

응답 파라미터

public class GetClusterInfoResponseVo {
    String clusterName;
    String kafkaVersionCode;
    String kafkaManagerUserName;
    String softwareProductCode;
    Integer vpcNo;
    String managerNodeProductCode;
    Integer managerNodeSubnetNo;
    String brokerNodeProductCode;
    Integer brokerNodeSubnetNo;
    Integer brokerNodeCount;
    Long brokerNodeStorageSize;
    Integer configGroupNo;
    String status;
}

필드

파라미터명	타입	설명
clusterName	String	클러스터 이름
kafkaVersionCode	String	Kafka 버전 코드
kafkaManagerUserName	String	CMAK 접속 아이디
softwareProductCode	String	사용중인 OS 타입
vpcNo	Integer	서버가 위치해 있는 VPC 번호
managerNodeProductCode	String	매니저 노드의 HW 스펙
managerNodeSubnetNo	Integer	매니저 노드가 위치해 있는 Subnet 번호
brokerNodeProductCode	String	브로커 노드의 HW 스펙
brokerNodeSubnetNo	Integer	브로커 노드가 위치해 있는 Subnet 이름
brokerNodeCount	Integer	브로커 노드 개수
brokerNodeStorageSize	Integer	브로커 노드의 스토리지 용량
conifgGroupNo	Integer	ConfigGroup의 번호
status	String	현재 클러스터 상태

응답 예시

{
  "code": 0,
  "message": "SUCCESS",
  "result": {
    "clusterName": "for-swagger",
    "kafkaVersionCode": "2403005",
    "kafkaManagerUserName": "string",
    "kafkaManagerUserPassword": "jeuJTgm5c6sYDlAcRrMf1A==",
    "softwareProductCode": "SW.VCDSS.OS.LNX64.CNTOS.0708.B050",
    "vpcNo": 3438,
    "managerNodeProductCode": "SVR.VCDSS.HICPU.C002.M004.NET.SSD.B050.G002",
    "managerNodeSubnetNo": 5573,
    "brokerNodeProductCode": "SVR.VCDSS.HICPU.C002.M004.NET.SSD.B050.G002",
    "brokerNodeSubnetNo": 4853,
    "brokerNodeCount": 3,
    "brokerNodeStorageSize": 100,
    "configGroupNo": 127,
    "status": "running"
  },
  "requestId": "6ab5082c-b672-411f-9174-877a658d0148"
}

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

What's Next

클러스터 상태 확인

설명
요청
응답 파라미터
필드

태그