createWorkflow

VPC環境で利用できます。

ワークフローを作成します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
POST	/api/v1/workflows

リクエストヘッダ

Data Flow APIで共通して使用されるヘッダの詳細は、Data Flowのリクエストヘッダをご参照ください。

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`name`	String	Required	ワークフロー名英数字、記号の「_」、「-」を組み合わせて3~100文字以内で入力先頭文字は英字または「_」のみ使用
`nodes`	Array	Required	ノード情報
`isTemp`	Boolean	Required	一時保存かどうか `true` \| `false` `true`: 一時保存 `false`: 即完了(一時保存しない)

`nodes`

nodesの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`id`	String	Required	ノード ID `triggerId` \| `jobId` `jobId`: getJobsを参照 (`type`が`TRIGGER`の場合) `jobId`: getTriggersを参照 (`type`が`JOB`の場合)
`name`	String	Required	ノード名トリガー名 \| ジョブ名トリガー名: getTriggersを参照 (`type`が`TRIGGER`の場合) ジョブ名: getJobsを参照 (`type`が`JOB`の場合)
`type`	String	Required	ノードタイプ `TRIGGER` \| `JOB`
`parentNodeIds`	Array	Required	上位ノード IDリストジョブノードオブジェクトはトリガーノードの IDを入力トリガーノードオブジェクトは空の値を維持
`triggerRule`	String	Optional	トリガーノードの実行オプション情報 `RECURRING` \| `ONE_TIME` \| `NONE` `RECURRING`: 周期実行 `ONE_TIME`: 特定日実行 `NONE`: 実行オプションなし
`jobCondition`	Object	Required	ジョブ実行オプション情報
`jobCondition.workerType`	String	Optional	ワーカータイプ `DATAFLOW`(デフォルト)
`jobCondition.numWorker`	Integer	Optional	ワーカー数 2 (デフォルト)
`jobCondition.timeout`	Integer	Optional	実行タイムアウト(分) ジョブを1回実行するにあたって結果を待つ時間 0~1440 (デフォルト: 360)
`jobCondition.nrn`	String	Required	ジョブに対する NAVERクラウドプラットフォームリソースの識別値
`jobCondition.scriptPath`	String	Required	ジョブ実行スクリプトの保存パス
`jobCondition.logPath`	String	Required	ジョブの実行履歴の保存パス

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request POST 'https://dataflow.apigw.ntruss.com/api/v1/workflows' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
  "name": "workflow001",
  "nodes": [
    {
      "id": "gqigvH******",
      "name": "job001",
      "type": "JOB",
      "parentNodeIds": [
        "d125za******"
      ],
      "jobCondition": {
        "workerType": "DEFAULT",
        "numWorker": 3,
        "timeout": 360,
        "nrn": "nrn:PUB:IAM::25****4:Role/****-a9d6-****-a85d-****",
        "scriptPath": "dataflow-33-****/scripts/",
        "logPath": "dataflow-33-****/sparkHistoryLogs/"
      }
    },
    {
      "id": "d125za******",
      "name": "trigger001",
      "type": "TRIGGER",
      "parentNodeIds": [],
      "triggerRule": "RECURRING"
    }
  ],
  "isTemp": false
}'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`workflowId`	String	-	ワークフロー ID
`name`	String	-	ワークフロー名
`nodes`	Array	-	ノード情報
`createdDate`	String	-	ワークフローの作成日時 ISO 8601形式(UTC+9を含む)
`updatedDate`	String	-	ワークフローの更新日時 ISO 8601形式(UTC+9を含む)
`isTemp`	Boolean	-	一時保存かどうか `true` \| `false` `true`: 一時保存 `false`: 即完了(一時保存しない)

`nodes`

nodesの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`id`	String	-	ノード ID `type`に応じて`triggerId`または`jobId`値を表示
`name`	String	-	ノード名 `type`に応じてトリガー名またはジョブ名を表示
`type`	String	-	ノードタイプ `TRIGGER` \| `JOB`
`parentNodeIds`	Array	-	上位ノード IDリストジョブノードオブジェクトはトリガーノードの IDを表示トリガーノードオブジェクトは空の値を表示
`triggerRule`	String	-	トリガーノードの実行オプション情報 `RECURRING` \| `ONE_TIME` \| `NONE` `RECURRING`: 周期実行 `ONE_TIME`: 特定日実行 `NONE`: 実行オプションなし
`isValid`	Boolean	-	ノードは削除されたか(ノードは使用可能か) `true` \| `false` `true`: 削除されていない(使用可能) `false`: 削除(使用不可)
`jobCondition`	Object	-	ジョブ実行オプション情報
`jobCondition.workerType`	String	-	ワーカータイプ `DATAFLOW`(デフォルト)
`jobCondition.numWorker`	Integer	-	ワーカー台数 2 (デフォルト)
`jobCondition.timeout`	Integer	-	実行タイムアウト(分) ジョブを1回実行するにあたって結果を待つ時間 0~1440 (デフォルト: 360)
`jobCondition.nrn`	String	-	ジョブに対する NAVERクラウドプラットフォームリソースの識別値
`jobCondition.scriptPath`	String	-	ジョブ実行スクリプトの保存パス
`jobCondition.logPath`	String	-	ジョブの実行履歴の保存パス

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

Data Flow APIで共通して使用されるレスポンスステータスコードの詳細は、Data Flow APIのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
  "workflowId" : "3tfNLP******",
  "name" : "workflow001",
  "nodes" : [ {
    "id" : "gqigvH******",
    "name" : "job001",
    "type" : "JOB",
    "parentNodeIds" : [ "8bjF7E******" ],
    "isValid" : true,
    "jobCondition" : {
      "workerType" : "DEFAULT",
      "numWorker" : 3,
      "timeout" : 360,
      "nrn" : "nrn:PUB:IAM::*******:Role/********-0496-11f0-baf6-246e96591a38",
      "scriptPath" : "dataflow-2706412-****/scripts/",
      "logPath" : "dataflow-2706412-****/sparkHistoryLogs/"
    }
  }, {
    "id" : "8bjF7E******",
    "name" : "trigger001",
    "type" : "TRIGGER",
    "parentNodeIds" : [ ],
    "triggerRule" : "RECURRING",
    "isValid" : true
  } ],
  "createdDate" : "2025-03-24T14:46:24+09:00",
  "updatedDate" : "2025-03-24T14:46:24+09:00",
  "isTemp" : false
}