createJobExecution

VPC環境で利用できます。

ジョブを実行します。

リクエスト

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

メソッド	URI
POST	/api/v1/jobs/{jobId}/executions

リクエストヘッダ

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

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`jobId`	String	Required	ジョブ ID getJobsを参照

リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`triggerId`	String	Optional	トリガー ID getTriggersを参照
`workflowId`	String	Optional	ワークフロー ID getWorkflowsを参照

リクエストボディ

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

フィールド	タイプ	必須の有無	説明
`jobCondition`	Object	Optional	ジョブ実行のオプション情報省略すると Jobに保存されている実行設定を使用
`jobCondition.numWorker`	Integer	Optional	ワーカー数 2~10 新規 Jobの初期設定値: 2
`jobCondition.timeout`	Integer	Optional	実行タイムアウト(分) ジョブを1回実行するにあたって結果を待つ時間 1~1440 新規 Jobの初期設定値: 360
`jobCondition.nrn`	String	Optional	ジョブに対する NAVERクラウドプラットフォームリソースの識別値
`jobCondition.scriptPath`	String	Optional	ジョブ実行スクリプトの保存先パス
`jobCondition.logPath`	String	Optional	ジョブの実行履歴の保存先パス
`jobCondition.parameters`	Object	Optional	この実行に適用するジョブパラメータ(`SCRIPT`ジョブ専用) キー・値形式の文字列マップジョブに宣言されたキーのみ値の変更が可能。渡したキーだけを上書きし、残りのキーはジョブに保存されている値を使用

リクエスト例

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

ジョブに保存されている実行設定で実行する例です。

curl --location --request POST 'https://dataflow.apigw.ntruss.com/api/v1/jobs/5Yns7J******/executions' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{}'

ワーカー数および一部のパラメータを今回の実行に限り変更する例です。

curl --location --request POST 'https://dataflow.apigw.ntruss.com/api/v1/jobs/5Yns7J******/executions' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
  "jobCondition": {
    "numWorker": 4,
    "parameters": {
      "target_date": "2025-03-23"
    }
  }
}'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`jobExecutionId`	String	-	ジョブの実行 ID
`jobId`	String	-	ジョブ ID
`jobCondition`	Object	-	ジョブ実行オプション情報
`jobCondition.numWorker`	Integer	-	ワーカー数 2~10
`jobCondition.timeout`	Integer	-	実行タイムアウト(分) 1~1440
`jobCondition.nrn`	String	-	ジョブに対する NAVERクラウドプラットフォームリソースの識別値
`jobCondition.scriptPath`	String	-	ジョブ実行スクリプトの保存先パス
`jobCondition.logPath`	String	-	ジョブの実行履歴の保存先パス
`jobCondition.parameters`	Object	-	この実行に適用されたジョブパラメータキー・値形式の文字列マップ
`status`	String	-	ジョブ実行の状態 `READY` \| `RUNNING` \| `COMPLETED` \| `FAILED` \| `CANCELLING` \| `CANCELLED` \| `TIMEOUT` `READY`: 実行待機 `RUNNING`: 実行中 `COMPLETED`: 完了 `FAILED`: 失敗 `CANCELLING`: キャンセル処理中 `CANCELLED`: キャンセル済み `TIMEOUT`: 実行制限時間超過実行リクエストのレスポンスでは常に`READY`
`startDate`	String	-	ジョブの実行日時 ISO 8601形式(UTC+9を含む)
`createdDate`	String	-	ジョブの作成日時 ISO 8601形式(UTC+9を含む)
`runningTime`	Integer	-	ジョブ実行時間(秒) 実行リクエストのレスポンスでは`0`
`type`	String	-	ジョブのタイプ `JOB` (デフォルト)

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

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

レスポンス例

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

{
  "jobExecutionId": "p4Y5Pk******",
  "jobId": "5Yns7J******",
  "jobCondition": {
    "numWorker": 4,
    "timeout": 360,
    "nrn": "nrn:PUB:IAM::*******:Role/********",
    "scriptPath": "dataflow-2706412-****/scripts/",
    "logPath": "dataflow-2706412-****/sparkHistoryLogs/",
    "parameters": {
      "target_date": "2025-03-23",
      "input_path": "aitems/sales/",
      "output_format": "parquet"
    }
  },
  "status": "READY",
  "startDate": "2025-03-23T09:00:12+09:00",
  "createdDate": "2025-03-23T09:00:12+09:00",
  "runningTime": 0,
  "type": "JOB"
}