Data Stream 개요

Prev Next

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

Data Stream은 실시간 데이터 스트리밍 처리를 위한 애플리케이션 구축 및 실행을 지원하는 네이버 클라우드 플랫폼의 완전 관리형 서버리스 서비스입니다. Data Stream 서비스에서는 토픽 및 커넥터 관리, 메시지 전송 관련 API를 RESTful 형태로 제공합니다.

Data Stream 공통 설정

Data Stream API에서 공통으로 사용하는 요청 형식과 응답 형식을 설명합니다.

요청

공통 요청 형식을 설명합니다.

API URL

요청 API URL은 다음과 같습니다.

Topic, Connector

https://datastream.apigw.ntruss.com

Messase

https://api.datastream.naverncp.com

요청 헤더

요청 헤더에 대한 설명은 다음과 같습니다.

필드 필수 여부 설명
x-ncp-apigw-timestamp Required 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간(밀리초)
  • API Gateway 서버와 5분 이상 시간 차 발생 시 유효하지 않은 요청으로 간주
  • Unix Timestamp 형식
x-ncp-iam-access-key Required 네이버 클라우드 플랫폼에서 발급받은 Access Key
x-ncp-apigw-signature-v2 Required 네이버 클라우드 플랫폼에서 발급받은 Access Key에 맵핑되는 Secret Key 및 HMAC 암호화 알고리즘(HmacSHA256)으로 요청 정보를 암호화한 후 Base64로 인코딩한 서명
Content-type Optional 요청 데이터의 형식
  • application/json
주의

메시지 전송 API에서는 보안을 위해 인증 시 네이버 클라우드 플랫폼 메인 계정의 Access Key, Secret Key를 사용할 수 없습니다. 따라서 서브 계정을 생성한 후 서브 계정의 Access Key, Secret Key를 사용해야 합니다. 서브 계정 생성 및 Access Key, Secret Key 확인 방법은 Sub Account 사용 가이드를 참조해 주십시오.

응답

공통 응답 형식을 설명합니다.

응답 상태 코드

응답 상태 코드에 대한 설명은 다음과 같습니다.

HTTP 상태 코드 내용 설명
200 - 요청 성공
201 - 리소스 생성
202 - 요청이 수락되었지만 아직 완료되지 않았음
400 Bad Request 요청 또는 인코딩 등의 잘못된 요청
401 Unauthorized 인증 실패
403 Forbidden 권한 없음
404 Not Found 확인할 수 없는 요청 정보
429 Too Many Requests 서비스 한도 초과
500 Internal Server Error 처리되지 않은 오류

응답 바디

응답 바디에 대한 설명은 다음과 같습니다. 호출이 성공한 경우의 응답 예시는 각 API 명세에서 확인해 주십시오.

error
error는 API 호출 실패 정보를 정의합니다. error에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
type String Optional 문제 유형을 식별하는 URI
title String Optional 오류 내용
status String Optional HTTP 상태 코드
instance String Optional 오류 발생 인스턴스
detail String Optional 오류 메시지 상세
code String Optional 오류 코드

error - code
code는 오류 원인 정보를 정의합니다. code에 대한 설명은 다음과 같습니다.

code 설명
InternalError 내부 오류
UserNotFound 찾을 수 없는 사용자
LimitExceeded 한도 초과
ResourceAlreadyExists 이미 존재하는 리소스
CreateFailure 생성 실패
DeleteFailure 삭제 실패
UpdateFailure 수정 실패
InvalidState 알 수 없는 상태
InvalidResourceNotFound 잘못된 리소스
InvalidBucketNotFound 잘못된 버킷
InvalidTopicNotFound 잘못된 토픽
InvalidConnectorNotFound 잘못된 커넥터
InvalidParameter 잘못된 파라미터
DuplicateName 중복된 이름
InvalidName 잘못된 이름
InvalidPartition 잘못된 파티션
InvalidRetention 잘못된 보존기간
InvalidDescription 잘못된 설명
InvalidConsumerSpec 잘못된 커넥터 사양
InvalidDateFormat 잘못된 날짜 형식
InvalidExportType 잘못된 커넥터 타입
InvalidLocation 잘못된 저장 위치
InvalidRoleNrn 잘못된 Sub Account 역할

응답 예시

호출이 성공한 경우의 응답 예시는 각 API 명세에서 확인해 주십시오. 호출이 실패한 경우의 응답 예시는 다음과 같습니다.

{
  "type": "about:blank",
  "title": "Bad Request",
  "status": 400,
  "instance": "/stream/api/topics/84dummy58-p",
  "detail": "Bad Request"
}
참고

메시지 전송 API는 별도 형식으로 응답합니다. 자세한 내용은 메시지 전송 API의 응답을 참조해 주십시오.

Data Stream API

Data Stream 서비스에서 제공하는 API에 대한 설명은 다음과 같습니다.

Topic

토픽 관련 API에 대한 설명은 다음과 같습니다.

API 설명
토픽 생성 토픽 생성
토픽 목록 조회 토픽 목록 조회
토픽 이름 접두사 조회 토픽 이름 접두사 조회
토픽 조회 토픽 상세 정보 조회
토픽 수정 토픽 설정 변경
토픽 삭제 토픽 삭제

Connector

커넥터 관련 API에 대한 설명은 다음과 같습니다.

API 설명
커넥터 생성 커넥터 생성
커넥터 조회 커넥터 상세 정보 조회
커넥터 수정 커넥터 설정 변경
커넥터 삭제 커넥터 삭제

Message

메시지 관련 API에 대한 설명은 다음과 같습니다.

API 설명
메시지 전송 토픽에 메시지(데이터) 전송

Data Stream 연관 리소스

Data Stream API에 대한 사용자의 이해를 돕기 위해 다양한 연관 리소스를 제공하고 있습니다.