Config Group 목록 조회

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

Kafka 버전별로 생성한 Config Group 목록을 조회합니다.

요청

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

메서드	URI
POST	/api/v1/configGroup/getKafkaVersionConfigGroupList (수도권)
POST	/api/krs-v1/configGroup/getKafkaVersionConfigGroupList (남부권)

요청 헤더

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

요청 바디

요청 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`kafkaVersionCode`	Integer	Required	Kafka 버전 코드 버전 조회 참조
`pageNo`	Integer	Optional	페이지 번호 1~N (기본값: 1)
`pageSize`	Integer	Optional	페이지 출력 수 1~N (기본값: 10)

요청 예시

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

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

응답

응답 형식을 설명합니다.

응답 바디

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

필드	타입	필수 여부	설명
`code`	Integer	-	응답 코드
`message`	String	-	응답 메시지
`result`	Object	-	응답 결과
`result.currentPage`	Integer	-	현재 페이지 번호
`result.isFirst`	Boolean	-	첫 페이지 여부 `true` \| `false` `true`: 첫 페이지 `false`: 첫 페이지 아님
`result.isLast`	Boolean	-	마지막 페이지 여부 `true` \| `false` `true`: 마지막 페이지 `false`: 마지막 페이지 아님
`result.pageSize`	Integer	-	페이지 출력 수
`result.totalCount`	Integer	-	응답 결과 수
`result.totalPage`	Integer	-	전체 페이지 수
`result.kafkaConfigGroupList`	Array	-	Config Group 목록
`requestId`	String	-	요청에 대한 아이디 UUID 형식

`kafkaConfigGroupList`

kafkaConfigGroupList에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`kafkaVersionCode`	Integer	-	Kafka 버전 코드
`kafkaVersion`	String	-	Kafka 버전
`configGroupNo`	Integer	-	Config Group 번호
`configGroupName`	String	-	Config Group 이름
`description`	String	-	Config Group 설명

참고

permission은 응답 결과에 노출될 수 있으나 사용자가 참조해야 하는 필드가 아니므로 사용 시 참고해 주십시오.

응답 상태 코드

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

응답 예시

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

{
    "code": 0,
    "message": "SUCCESS",
    "result": {
        "currentPage": 1,
        "isFirst": true,
        "isLast": true,
        "pageSize": 10,
        "totalCount": 1,
        "totalPage": 1,
        "kafkaConfigGroupList": [
            {
                "kafkaVersionCode": "3903006",
                "kafkaVersion": "3.9.0",
                "configGroupNo": 3**,
                "configGroupName": "cg1",
                "description": "config group 1",
                "permission": "Allow"
            }
        ]
    },
    "requestId": "34926977-****-****-****-ff0ad6816d93"
}