Config Group Kafka 설정 조회

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

Config Group의 Kafka 상세 설정을 조회합니다.

요청

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

메서드	URI
POST	/api/v1/configGroup/getKafkaConfigGroupDetailList/{configGroupNo} (수도권)
POST	/api/krs-v1/configGroup/getKafkaConfigGroupDetailList/{configGroupNo} (남부권)

요청 헤더

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

요청 경로 파라미터

요청 경로 파라미터에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`configGroupNo`	Integer	Required	Config Group 번호 Config Group 목록 조회 참조

요청 바디

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

필드	타입	필수 여부	설명
`kafkaVersionCode`	Integer	Required	Kafka 버전 코드 버전 조회 참조

요청 예시

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

curl --location --request POST 'https://clouddatastreamingservice.apigw.gov-ntruss.com/api/v1/configGroup/getKafkaConfigGroupDetailList/3**' \
--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"
}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드	타입	필수 여부	설명
`code`	Integer	-	응답 코드
`message`	String	-	응답 메시지
`result`	Object	-	응답 결과
`result.memberNo`	String	-	사용자의 네이버 클라우드 플랫폼 회원 번호
`result.configGroupNo`	Integer	-	Config Group 번호
`result.kafkaVersionCode`	String	-	Kafka 버전 코드
`result.additionalKafkaConfigGroupDetailList`	Array	-	사용자 정의 상세 설정 목록
`result.kafkaConfigGroupDetailList`	Array	-	상세 설정 목록
`requestId`	String	-	요청에 대한 아이디 UUID 형식

`additionalKafkaConfigGroupDetailList`

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

필드	타입	필수 여부	설명
`configName`	String	-	Config 이름 Kafka 설정 파일(Serverproperties)에서 사용되는 이름
`type`	String	-	Config 데이터 타입
`range`	String	-	Config 값 범위
`defaultValue`	String	-	Config 기본값
`configValue`	String	-	Config의 사용자 지정 값
`modifyYn`	Boolean	-	사용자 수정 가능 여부 `true` \| `false` `true`: 가능 `false`: 불가

`kafkaConfigGroupDetailList`

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

필드	타입	필수 여부	설명
`configNameKey`	String	-	Config 이름 키 Kafka 설정 변경 시 사용되는 이름
`configName`	String	-	Config 이름 Kafka 설정 파일(Serverproperties)에서 사용되는 이름
`type`	String	-	Config 데이터 타입
`defaultValue`	String	-	Config 기본값
`range`	String	-	Config 값 범위
`customValue`	String	-	Config의 사용자 지정 값
`modifyYn`	Boolean	-	사용자 수정 가능 여부 `true` \| `false` `true`: 가능 `false`: 불가

응답 상태 코드

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

응답 예시

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

{
    "code": 0,
    "message": "SUCCESS",
    "result": {
        "memberNo": "500****",
        "configGroupNo": 3**,
        "kafkaVersionCode": "3903006",
        "additionalKafkaConfigGroupDetailList": [
            {
                "configName": "compression.type",
                "type": "String",
                "range": "[\"lz4\", \"zstd\"]",
                "defaultValue": "lz4",
                "configValue": "",
                "modifyYn": true
            }
        ],
        "kafkaConfigGroupDetailList": [
            {
                "configNameKey": "autoCreateTopicsEnable",
                "configName": "auto.create.topics.enable",
                "type": "Boolean",
                "defaultValue": "true",
                "range": "",
                "customValue": null,
                "modifyYn": true
            },
            {
                "configNameKey": "deleteTopicEnable",
                "configName": "delete.topic.enable",
                "type": "Boolean",
                "defaultValue": "true",
                "range": "",
                "customValue": null,
                "modifyYn": true
            },
            {
                "configNameKey": "offsetsTopicReplicationFactor",
                "configName": "offsets.topic.replication.factor",
                "type": "Integer",
                "defaultValue": "3",
                "range": "1~128",
                "customValue": null,
                "modifyYn": true
            },
            ...
        ]
    },
    "requestId": "1dff09ee-****-****-****-236257061888"
}