Data Flow の概要
- 印刷する
- PDF
Data Flow の概要
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
Data Flowは、NAVERクラウドプラットフォームの API Gatewayを通じて APIを提供します。
API認証のためには Access Key、Secret Keyが必要であり、
API Keyの作成および使用方法は、API Gatewayご利用ガイド > API呼び出しをご参照ください。
Access Keyと Secret Keyについては、共通ガイド > API の概要をご参照ください。
Data Flowは様々な APIを提供しており、Swaggerページを通じて APIスペックを確認し、簡単なテストを行うことができます。Data Flowの Swagger文書は、以下をご参照ください。
- NAVERクラウドプラットフォームのコンソールにアクセスします。
- Services > API Gateway メニューを順にクリックします。
- Published APIs > Data Flow > Catalog を順にクリックします。
- Data Flow をクリックし、下記の API説明書 をクリックします。
この時に表示される画面が AiTEMSの Swaggerページであり、ページの一番上に表示されているリンク(https://dataflow.apigw.ntruss.com/api/v1)が AiTEMSの APIアドレスです。
共通設定
Data Flow API URL
https://dataflow.apigw.ntruss.com/api/v1
リクエストヘッダ
| ヘッダ名 | 説明 |
|---|---|
| x-ncp-apigw-timestamp | 1970年1月1日 00:00:00 協定世界時(UTC)からの経過時間をミリ秒(Millisecond)で表し、API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとみなすx-ncp-apigw-timestamp:{Timestamp} |
| x-ncp-iam-access-key | NAVERクラウドプラットフォームポータルで発行された Access Key ID値x-ncp-iam-access-key:{Sub Account Access Key} |
| x-ncp-apigw-signature-v2 | Access Key ID値と Secret Keyで暗号化した署名x-ncp-apigw-signature-v2:{API Gateway Signature} |
| Content-Type | Request body content typeを application/jsonに指定Content-Type: application/json |
オペレーション
Dashboard
| API名 | 説明 |
|---|---|
| getExecutionResult | タスクの総実行数、成功および失敗数を照会 |
| getExecutionCount | 当該期間のタスク実行数を照会 |
| getExecutionTimes | 当該期間のタスク実行時間を照会 |
Workflow
| API名 | 説明 |
|---|---|
| getWorkflows | ワークフローリストを照会 |
| getWorkflowById | ワークフローを照会 |
| createWorkflow | ワークフローを作成 |
| updateWorkflow | ワークフローを変更 |
| deleteWorkflow | ワークフローを削除 |
| getWorkflowExecutions | ワークフロー実行リストを照会 |
Job
| API名 | 説明 |
|---|---|
| getJobs | タスクリストを照会 |
| getJobById | タスクを照会 |
| createJob | タスクを作成 |
| updateJob | タスクを変更 |
| deleteJob | タスクを削除 |
| verifyJob | タスクリクエスト項目を検証 |
| executeJob | タスクを実行 |
| getJobExecutions | タスク実行リストを照会 |
| getJobExecutionById | タスク実行詳細を照会 |
| updateJobExecuteConfig | タスク実行設定を変更 |
Trigger
| API名 | 説明 |
|---|---|
| getTriggers | クラスタリストを照会 |
| getTriggerById | トリガーを照会 |
| createTrigger | トリガーを作成 |
| deleteTrigger | トリガーを削除 |
エラーレスポンスの形式
APIリクエストが間違っていたり、処理中にエラーが発生した場合、HTTP状態コードで成功/失敗を返し、JSON形式で詳細メッセージを返します。
レスポンス例
{
"type": "about:blank",
"title": "Not Found",
"status": 404,
"detail": "{workflowId=aa}: 見つかりません。",
"instance": "/dataflow/api/workflows/aa",
"errorType": "resource-not-found/WORKFLOW"
}
エラーレスポンス
| HTTP状態コード | エラータイプ | メッセージ | 説明 | 解決策 |
|---|---|---|---|---|
| 400 | bad-parameter | パラメータを確認します。 | リクエストパラメータエラー | リクエスト値を再確認 |
| 400 | bad-state | 状態を確認します。 | リクエスト状態エラー | リクエスト対象の状態を再確認 |
| 404 | resource-not-found/ | 項目が見つかりません。 | リクエストリソース IDエラー | リクエスト対象を再確認 |
| 400 | client-request-failed | リクエストに失敗しました。 | 連携サービスのリクエストエラー | 連携サービスを確認 |
| 400 | client-resource-not-found | リソースが見つかりません。 | 連携サービスのリソースエラー | 連携サービスのリソースを確認 |
| 400 | client-unauthorized | 権限がありません。 | 連携サービスの権限エラー | 連携サービスの権限を確認 |
| 500 | unknown-resource-action/ | 予期せぬエラーが発生しました。 | タスク実行エラー | カスタマーサポート > お問い合わせでお問い合わせ |
この記事は役に立ちましたか?