ConfigGroup Kafka 버전별 목록 조회

Prev Next

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

설명

Cloud Data Streaming Service의 KafkaVersion에 따라 사용 가능한 ConfigGroup정보를 조회 합니다.

요청

요청 URL

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

요청 헤더

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

요청 파라미터

파라미터 타입 필수 여부 설명
kafkaVersionCode String Y - 사용할 Cloud Data Streaming Service 버전
getCDSSVersion 액션을 통해 획득 가능
pageNo Integer N 표시할 페이지 번호 (Default : 1)
pageSize Integer N 표시할 페이지 사이즈 (Default:10)

요청 예시

POST https://clouddatastreamingservice.apigw.gov-ntruss.com/api/v1/configGroup/getKafkaVersionConfigGroupList
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

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

curl -X POST "https://clouddatastreamingservice.apigw.gov-ntruss.com/api/v1/configGroup/getKafkaVersionConfigGroupList" \
-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 \
'{
  "kafkaVersionCode": "2403005",
  "pageNo": 1,
  "pageSize": 10
}'

응답 파라미터

public class GetKafkaConfigGroupListResponseVo {
    private Integer currentPage;
    private Boolean isFirst;
    private Boolean isLast;
    private Integer pageSize;
    private Long totalCount;
    private Integer totalPage;
    private List<KafkaConfigGroup> KafkaConfigGroupList;
}

public class KafkaConfigGroup {
    private String kafkaVersionCode;
    private String kafkaVersion;
    private Integer configGroupNo;
    private String configGroupName;
    private String description;
}

필드

파라미터명 타입 설명
currentPage Integer 현재 페이지 번호
isFirst Boolean 첫 페이지 여부
isLast Boolean 마지막 페이지 여부
pageSize Integer 페이지에 표시할 데이터의 갯수
totalCount Long 조회된 전체 데이터의 갯수
totalPage Integer 전체 페이지의 갯수(totalCount/pageSize)
kafkaConfigGroupList List<KafkaConfigGroup> ConfigGroup 목록 리스트
kafkaVersionCode String Cloud Data Streaming Service 버전
getCDSSVersion 액션을 통해 획득 가능
kafkaVersion String 실제 Cluster에서 사용되는 Kafka의 Version
configGroupNo Integer ConfigGroup 의 번호
configGroupName String ConfigGroup 의 이름
description String ConfigGroup의 사용자 Description

응답 예시(성공)

{
  "code": 0,
  "message": "SUCCESS",
  "result": {
    "currentPage": 1,
    "isFirst": true,
    "isLast": true,
    "pageSize": 10,
    "totalCount": 2,
    "totalPage": 1,
    "kafkaConfigGroupList": [
      {
        "kafkaVersionCode": "2403005",
        "kafkaVersion": "2.4.0",
        "configGroupNo": 174,
        "configGroupName": "config-test",
        "description": "실제 테스트"
      },
      {
        "kafkaVersionCode": "2403005",
        "kafkaVersion": "2.4.0",
        "configGroupNo": 236,
        "configGroupName": "ttttetetet",
        "description": "Description 수정 추가 "
      }
    ]
  },
  "requestId": "e1b45201-d865-416d-af16-a7dea176a727"
}