Data Flowの概要

Prev Next

VPC環境で利用できます。

Data Flowは、大規模なデータを抽出、変換、ロードするための複雑なワークフローを構成・実行し、モニタリングする NAVERクラウドプラットフォームの完全管理型データ統合サービスです。Data Flowサービスは、Workflow、Job、Trigger機能関連の APIを RESTful形式で提供します。

Data Flowの共通設定

Data Flow APIで共通して使用されるリクエスト形式とレスポンス形式を説明します。

リクエスト

共通リクエスト形式を説明します。

API URL

リクエスト API URLは次の通りです。

https://dataflow.apigw.ntruss.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にエンコードした署名

レスポンス

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

レスポンスボディ

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

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

フィールド タイプ 必須の有無 説明
error Object - エラーコードとメッセージ
error.errorCode String Required エラーコード
error.message String Required エラーメッセージ
error.details String Required エラーメッセージの詳細説明

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

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

HTTPステータスコード コード メッセージ 説明 解決方法
200 - OK リクエスト処理成功 -
201 - Created 作成完了 -
202 - Request is accepted but not completed yet. リクエストは受け取ったが、まだ完了していない -
204 - No Content リクエスト処理成功、コンテンツは返していない -
400 - Bad Request 無効なリクエスト リクエスト構文を確認
400 - bad-parameter リクエストパラメータエラー リクエスト値を確認
400 - bad-state リクエスト状態エラー リクエスト対象の状態を確認
400 - client-request-failed 連携サービスのリクエストエラー 連携サービスを確認
400 - client-resource-not-found 連携サービスのリソースエラー 連携サービスのリソースを確認
400 - client-unauthorized 連携サービスの権限エラー 連携サービスの権限を確認
400 - No valid member exists of given member number. 無効なリクエスト リクエストパラメータ、ヘッダを再確認
401 - Unauthorized 認証失敗 ジョブの作成者とリクエスタの権限を確認
403 - Forbidden サーバのジョブ拒否 リクエスト機能に対する使用権限を所有しているか確認
404 - resource-not-found リクエストリソース IDエラー リクエスト対象を確認
500 - unknown-resource-action ジョブ実行エラー NAVERクラウドプラットフォームポータルのお問い合わせから問い合わせる
500 - Internal Server Error サーバ内部エラー しばらくしてから再試行
参考

NAVERクラウドプラットフォームで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。

レスポンス例

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

{
    "error": {
        "errorCode": "200",
        "message": "Authentication Failed",
        "details": "Invalid authentication information."
    }
}

Data Flow API

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

Dashboard

Dashboard関連 APIの説明は次の通りです。

API 説明
getExecutionInterval ジョブの実行数を照会
getExecutionResult ジョブの実行数、成功数、失敗数を照会
getExecutionTimes ジョブの実行時間を照会

Workflow

ワークフロー関連 APIの説明は次の通りです。

API 説明
createWorkflow ワークフローを作成
getWorkflows ワークフローリストを照会
getWorkflowById ワークフローの詳細情報を照会
getWorkflowExecutions ワークフロー実行リストを照会
updateWorkflow ワークフローを更新
deleteWorkflow ワークフローを削除

Job

ジョブ関連 APIの説明は次の通りです。

API 説明
createJob ジョブを作成
getJobs ジョブリストを照会
getJobById ジョブの詳細情報を照会
updateJob ジョブを更新
verifyJob ジョブ実行リクエスト項目を検証
executeJob ジョブを実行
getJobExecutions ジョブ実行リストを照会
getJobExecutionById ジョブ実行の詳細情報を照会
updateJobExecuteConfig ジョブ実行オプションを更新
deleteJob ジョブを削除

Trigger

トリガー関連 APIの説明は次の通りです。

API 説明
createTrigger トリガーを作成
getTriggers トリガーリストを照会
getTriggerById トリガーの詳細を個別照会
deleteTrigger トリガーを削除

Data Flow関連リソース

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