ConfigGroup을 사용 중인 Cluster 목록 조회

Prev Next

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

설명

Cloud Data Streaming Service의 ConfigGroup을 사용중인 Cluster 목록을 조회합니다.

요청

요청 URL

POST https://clouddatastreamingservice.apigw.gov-ntruss.com/api/v1/configGroup/getConfigGroupUsingClusterList/{configGroupNo} [수도권]
POST https://clouddatastreamingservice.apigw.gov-ntruss.com/api/krs-v1/configGroup/getConfigGroupUsingClusterList/{configGroupNo} [남부권]

요청 헤더

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

요청 파라미터

파라미터 타입 필수 여부 설명
configGroupNo String Y - ConfigGroupNo
대상 ConfigGroup 의 번호
pageNo Integer N 표시할 페이지 번호 (Default : 1)
pageSize Integer N 표시할 페이지 사이즈 (Default:10)

요청 예시

POST https://clouddatastreamingservice.apigw.gov-ntruss.com/api/v1/configGroup/getConfigGroupUsingClusterList/174
HOST: clouddatastreamingservice.apigw.gov-ntruss.com
Content-Type: application/json
x-ncp-apigw-signature-v2: uLWYAZULzt3UZl5MeUo5Xj1mepW49qSMKc9n2rMv/YA=
x-ncp-apigw-timestamp: 1653981745173
x-ncp-iam-access-key: 7fIvgFY428mtY6sY8maw

{
  "pageNo": 1,
  "pageSize": 10
}

curl -X POST "https://clouddatastreamingservice.apigw.gov-ntruss.com/api/v1/configGroup/getConfigGroupUsingClusterList/174" \
-H "accept: application/json" \
-H "Content-Type: application/json" \
-H "x-ncp-iam-access-key: ANJNnR1jz1gUzaiS0aV2" \
-H "x-ncp-apigw-timestamp: 1653981745173" \
-H "x-ncp-apigw-signature-v2: uLWYAZULzt3UZl5MeUo5Xj1mepW49qSMKc9n2rMv/YA=" \
-d \
'{
  "pageNo": 1,
  "pageSize": 10
}'

응답 파라미터

public class GetConfigGroupUsingClusterListResponseVo {
    private Integer currentPage;
    private Boolean isFirst;
    private Boolean isLast;
    private Integer pageSize;
    private Long totalCount;
    private Integer totalPage;
    private List<usingClusterNameList> ConfigGroupClusterInfo;
}

public class usingClusterNameList {
    private String clusterName;
    private Integer serviceGroupInstanceNo;
}

필드

파라미터명 타입 설명
currentPage Integer 현재 페이지 번호
isFirst Boolean 첫 페이지 여부
isLast Boolean 마지막 페이지 여부
pageSize Integer 페이지에 표시할 데이터의 갯수
totalCount Long 조회된 전체 데이터의 갯수
totalPage Integer 전체 페이지의 갯수(totalCount/pageSize)
kafkaConfigGroupList List<usingClusterNameList> ConfigGroup을 사용중인 Cluster 리스트
serviceGroupInstanceNo Integer Cluster 인스턴스 번호
clusterName String Cluster 의 이름

응답 예시(성공)

{
  "code": 0,
  "message": "SUCCESS",
  "result": {
    "currentPage": 1,
    "isFirst": true,
    "isLast": true,
    "pageSize": 10,
    "totalCount": 2,
    "totalPage": 1,
    "usingClusterNameList": [
      {
        "clusterName": "cluster-sample1",
        "serviceGroupInstanceNo": 2389832
      },
      {
        "clusterName": "cluster-sample2",
        "serviceGroupInstanceNo": 2389848
      }
    ]
  },
  "requestId": "86f64c9b-053a-4069-94c9-644ece14b506"
}