Config Group 조회

Prev Next

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

Config Group의 상세 정보를 조회합니다.

요청

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

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

요청 헤더

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

요청 경로 파라미터

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

필드 타입 필수 여부 설명
configGroupNo Integer Required Config Group 번호

요청 바디

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

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

요청 예시

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

curl --location --request POST 'https://clouddatastreamingservice.apigw.gov-ntruss.com/api/v1/configGroup/getKafkaConfigGroup/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.configGroupNo Integer - Config Group 번호
result.memberNo String - 사용자의 네이버 클라우드 플랫폼 회원 번호
result.configGroupName String - Config Group 이름
result.kafkaVersionCode String - Kafka 버전 코드
result.description String - Config Group 설명
requestId String - 요청에 대한 아이디
  • UUID 형식

응답 상태 코드

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

응답 예시

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

{
    "code": 0,
    "message": "SUCCESS",
    "result": {
        "configGroupNo": 3**,
        "memberNo": "500****",
        "configGroupName": "cg1",
        "kafkaVersionCode": "3903006",
        "description": "config group 1"
    },
    "requestId": "cf182753-****-****-****-68f64cadf730"
}