Data Streamの概要

Prev Next

VPC環境で利用できます。

Data Streamは、リアルタイムデータストリーミング処理用アプリケーションの構築と実行をサポートする NAVERクラウドプラットフォームの完全管理型サーバレスサービスです。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 NAVERクラウドプラットフォームから発行された Access Key
x-ncp-apigw-signature-v2 Required NAVERクラウドプラットフォームから発行された Access Keyとマッピングする Secret Keyと HMAC暗号化アルゴリズム(HmacSHA256)でリクエスト情報を暗号化した後、Base64にエンコードした署名
Content-type Optional リクエストデータの形式
  • application/json
注意

メッセージ送信 APIでは、セキュリティのため、認証時に NAVERクラウドプラットフォームメインアカウントの 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についてユーザーの理解に役立つよう、さまざまな関連リソースを提供しています。