ConfigGroup 정보 조회

Prev Next

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

설명

Cloud Data Streaming Service Config Group의 정보를 조회 합니다.

요청

요청 URL

POST https://clouddatastreamingservice.apigw.gov-ntruss.com/api/v1/configGroup/getKafkaConfigGroup/{configGroupNo} [수도권]
POST https://clouddatastreamingservice.apigw.gov-ntruss.com/api/krs-v1/configGroup/getKafkaConfigGroup/{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 의 번호
kafkaVersionCode String Y - 사용할 Cloud Data Streaming Service 버전
getCDSSVersion 액션을 통해 획득 가능

요청 예시

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

curl -X POST "https://clouddatastreamingservice.apigw.gov-ntruss.com/api/v1/configGroup/getKafkaConfigGroup/236" \
-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"
}'

응답 파라미터

public class GetKafkaConfigGroupResponseVo{
    private Integer configGroupNo;
    private String memberNo;
    private String configGroupName;
    private String kafkaVersionCode;
    private String description;
}

필드

파라미터명 타입 설명
configGroupNo Integer ConfigGroup 번호
memberNo String Member 번호
configGroupName String ConfigGroup 이름
kafkaVersionCode String ConfigGroup에서 사용 가능한 Kafka Version 코드
description String 사용자 Description

응답 예시(성공)

{
  "code": 0,
  "message": "SUCCESS",
  "result": {
    "configGroupNo": 236,
    "memberNo": "46",
    "configGroupName": "configgroup-1",
    "kafkaVersionCode": "2403005",
    "description": "컨피그 그룹 1"
  },
  "requestId": "b3dcf8e3-4111-4ac4-92e1-b80280fb160d"
}