토픽 생성

Prev Next

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

토픽을 생성합니다.

요청

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

메서드 URI
POST /api/v1/topics

요청 헤더

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

요청 바디

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

필드 타입 필수 여부 설명
name String Required 토픽 이름
  • 접두사-이름 형태로 입력
  • 영문 소문자, 숫자, 특수 문자 '-'를 조합하여 접두사 포함 200자 이내로 입력
  • 토픽 이름 접두사 조회 참조
  • <예시> 토픽 이름 접두사가 h4j6l-, 설정할 이름이 ds001인 경우: h4j6l-ds001로 입력
description String Optional 토픽 설명 (최대 200자)
partitions Number Optional 토픽 파티션 수
  • 1~16 (기본값: 1)
retentionMs Number Optional 토픽 파티션 메시지 보존 기간(밀리초)
  • 3600000~1296000000 (기본값: 86400000)

요청 예시

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

curl --location --request POST 'https://datastream.apigw.ntruss.com/api/v1/topics' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
    "name": "h4j6l-ds001",
    "description": "Data Stream Topic",
    "partitions": 1,
    "retentionMs": 86400000
}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드 타입 필수 여부 설명
topicId String - 토픽 아이디
topicName String - 토픽 이름
description String - 토픽 설명
partitions Number - 토픽 파티션 수
retentionMs Number - 토픽 파티션 메시지 보존 기간(밀리초)
status String - 토픽 상태
  • CREATING|CREATED
    • CREATING: 토픽 생성 중
    • CREATED: 토픽 생성 완료(활성)
tcpEndpoint String - TCP 엔드포인트
createdDate String - 토픽 생성 일시
  • ISO 8601 형식
  • YYYY-MM-DDThh:mm:ssZ
updatedDate String - 토픽 수정 일시
  • ISO 8601 형식
  • YYYY-MM-DDThh:mm:ssZ

응답 상태 코드

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

응답 예시

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

{
    "topicId": "jkH8v*****",
    "topicName": "h4j6l-ds001",
    "description": "Data Stream Topic",
    "partitions": 1,
    "retentionMs": 86400000,
    "status": "CREATED",
    "tcpEndpoint": "sample-cluster.datastream.naverncp.com:{PORT}",
    "createdDate": "2025-05-28T17:29:21Z",
    "updatedDate": "2025-05-28T17:29:21Z"
}