클러스터 상태 확인

Prev Next

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

설명

Cloud Data Streaming Service Cluster의 상태를 확인합니다.

요청

요청 URL

GET https://clouddatastreamingservice.apigw.gov-ntruss.com/api/v1/cluster/getClusterStatus/{service-group-instance-no} [수도권]
GET https://clouddatastreamingservice.apigw.gov-ntruss.com/api/krs-v1/cluster/getClusterStatus/{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 번호

요청 예시

GET https://clouddatastreamingservice.apigw.gov-ntruss.com/api/v1/cluster/getClusterStatus/1484848
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 GET "https://clouddatastreamingservice.apigw.gov-ntruss.com/api/v1/cluster/getClusterStatus/1484848" \
-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 GetBrokerNodeListsResponseVo {
    String clusterName;
    Integer brokerNodeTotalNumber;
    Integer brokerNumber;
    String brokerStatus;
    List<ProcessStatusVo> brokerStatusPerNode;
    Integer zookeeperTotalNumber;
    Integer zookeeperNumber;
    String zookeeperStatus;
    List<ProcessStatusVo> zookeeperStatusPerNode;
    String cmakStatus;
}

public class ProcessStatusVo {
    String hostname;
    String status;
}

필드

파라미터명 타입 설명
clusterName String Cluster 이름
brokerNodeTotalNumber Integer 브로커 노드 총 개수
brokerNumber Integer 현재 작동하고 있는 브로커 노드 개수
brokerStatus String 브로커 상태(green 정상 작동, red 비정상 작동, gray 알 수 없음)
brokerStatusPerNode List 노드별 브로커 상태
zookeeperTotalNumber Integer 주키퍼 노드 총 개수
zookeeperNumber Integer 현재 작동하고 있는 주키퍼 노드 개수
zookeeperStatus String 주키퍼 상태(green 정상 작동, red 비정상 작동)
zookeeperStatusPerNode List 노드별 주키퍼 상태
cmakStatus String CMAK 상태(green 정상 작동, red 비정상 작동, gray 알 수 없음)
hostname String 서버 인스턴스 이름
status String 프로세스 상태(green 정상 작동, red 비정상 작동, gray 알 수 없음)

응답 예시

{
  "code": 0,
  "message": "SUCCESS",
  "result": {
    "clusterName": "test",
    "brokerNodeTotalNumber": 3,
    "brokerNumber": 3,
    "brokerStatus": "green",
    "brokerStatusPerNode": [
      {
        "hostname": "test-b-95q",
        "status": "green"
      },
      {
        "hostname": "test-b-95r",
        "status": "green"
      },
      {
        "hostname": "test-b-95s",
        "status": "green"
      }
    ],
    "zookeeperTotalNumber": 3,
    "zookeeperNumber": 3,
    "zookeeperStatus": "green",
    "zookeeperStatusPerNode": [
      {
        "hostname": "test-b-95q",
        "status": "green"
      },
      {
        "hostname": "test-b-95r",
        "status": "green"
      },
      {
        "hostname": "test-b-95s",
        "status": "green"
      }
    ],
    "cmakStatus": "green"
  },
  "requestId": "c2ce20ec-d296-43dd-872b-3a1d5e860a8b"
}