MENU
      Login
          Login
          目次 x
          Data Flow の概要
            目次

            Data Flow の概要

              記事の要約

              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文書は、以下をご参照ください。

                1. NAVERクラウドプラットフォームのコンソールにアクセスします。
              2. Services > API Gateway メニューを順にクリックします。
              3. Published APIs > Data Flow > Catalog を順にクリックします。
              4. 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
              HTTP

              リクエストヘッダ

              ヘッダ名説明
              x-ncp-apigw-timestamp1970年1月1日 00:00:00 協定世界時(UTC)からの経過時間をミリ秒(Millisecond)で表し、API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとみなす
              x-ncp-apigw-timestamp:{Timestamp}
              x-ncp-iam-access-keyNAVERクラウドプラットフォームポータルで発行された Access Key ID値
              x-ncp-iam-access-key:{Sub Account Access Key}
              x-ncp-apigw-signature-v2Access Key ID値と Secret Keyで暗号化した署名
              x-ncp-apigw-signature-v2:{API Gateway Signature}
              Content-TypeRequest 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"
}
              JSON

              エラーレスポンス

              HTTP状態コードエラータイプメッセージ説明解決策
              400bad-parameterパラメータを確認します。リクエストパラメータエラーリクエスト値を再確認
              400bad-state状態を確認します。リクエスト状態エラーリクエスト対象の状態を再確認
              404resource-not-found/項目が見つかりません。リクエストリソース IDエラーリクエスト対象を再確認
              400client-request-failedリクエストに失敗しました。連携サービスのリクエストエラー連携サービスを確認
              400client-resource-not-foundリソースが見つかりません。連携サービスのリソースエラー連携サービスのリソースを確認
              400client-unauthorized権限がありません。連携サービスの権限エラー連携サービスの権限を確認
              500unknown-resource-action/予期せぬエラーが発生しました。タスク実行エラーカスタマーサポート > お問い合わせでお問い合わせ
              この記事は役に立ちましたか?
              Change password!
              Changing your password will log you out immediately. Use the new password to log back in.
              Change profile
              Success!
              First name must have atleast 2 characters. Numbers and special characters are not allowed.
              Last name must have atleast 1 characters. Numbers and special characters are not allowed.
              Enter a valid email
              Enter a valid password
              Your profile has been successfully updated.
              Logout