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
参考

Topic、Connector APIはサポート予定です。

リクエストヘッダ

リクエストヘッダの説明は次の通りです。

フィールド 必須の有無 説明
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ご利用ガイドをご参照ください。

レスポンス

共通レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

error
errorは API呼び出し失敗情報を定義します。errorの説明は次の通りです。

フィールド タイプ 必須の有無 説明
type String Optional 問題タイプを識別する URI
title String Optional エラー内容
status String Optional エラーコード
instance String Optional エラー発生インスタンス
detail String Optional エラーメッセージの詳細

レスポンスステータスコード

レスポンスステータスコードの説明は次の通りです。

HTTPステータスコード コード (status) 内容 (title) メッセージの詳細 (detail) 説明
200 - OK - リクエスト成功
201 - Created - リクエスト成功、リソース作成
202 - Accepted - リクエストは受け取ったが、まだ完了していない
400 400 Bad Request client-bad-request リクエストまたはエンコードなどの無効なリクエスト
401 401 Unauthorized client-unauthorized 認証失敗
403 403 Forbidden client-forbidden 権限なし
404 404 Not Found client-resource-not-found 不明なリクエスト情報
429 429 Too Many Requests client-quota-exceeded サービス上限超過
500 500 Internal Server Error unexpected-client-error 処理されていないエラー

レスポンス例

呼び出しが失敗した場合のレスポンス例は、各 API仕様書を確認してください。呼び出しに成功した場合のレスポンスのサンプルコードは次の通りです。

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

Data Stream API

Data Streamサービスが提供する APIの説明は次の通りです。

Message

メッセージ関連 APIの説明は次の通りです。

API 説明
メッセージの送信 トピックにメッセージ(データ)を送信

Data Stream関連リソース

Data Stream APIについてユーザーの理解に役立つよう、さまざまな関連リソースを提供しています。