executeJob

Prev Next

VPC環境で利用できます。

ジョブを実行します。

リクエスト

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

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

リクエストヘッダ

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

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

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

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

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

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

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

リクエストボディ

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

フィールド タイプ 必須の有無 説明
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 ジョブの実行履歴の保存パス
parameters Object Optional ジョブの実行パラメータ

リクエスト例

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

curl --location --request POST 'https://dataflow.apigw.ntruss.com/api/v1/jobs/gqigvH******/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": {
    "workerType": "DEFAULT",
    "numWorker": 2,
    "timeout": 360,
    "nrn": "nrn:PUB:IAM::*******:Role/********-0496-11f0-baf6-246e96591a38",
    "scriptPath": "dataflow-2706412-****/scripts/",
    "logPath": "dataflow-2706412-****/sparkHistoryLogs/"
  },
  "parameters": {
    "$table_name": "test.sample_table2"
  }
}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
jobExecutionId String - ジョブの実行 ID
jobId String - ジョブ ID
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 - ジョブの実行履歴の保存パス
status String - ジョブの最終実行状態
  • READY | RUNNING | COMPLETED | FAILED | CANCELED
    • READY: 待機中
    • RUNNING: 実行中
    • COMPLETED: 完了
    • FAILED: 失敗
    • CANCELED: キャンセル
startDate String - ジョブの実行日時
  • ISO 8601形式(UTC+9を含む)
createdDate String - ジョブの作成日時
  • ISO 8601形式(UTC+9を含む)
runningTime Integer - ジョブの実行時間(分)
parsedParameters Object - パースされたジョブ実行パラメータ
type String - ジョブのタイプ
  • JOB (デフォルト)

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

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

レスポンス例

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

{
  "jobExecutionId" : "p4Y5Pk******",
  "jobId" : "gqigvH******",
  "jobCondition" : {
    "workerType" : "DEFAULT",
    "numWorker" : 2,
    "timeout" : 360,
    "nrn" : "nrn:PUB:IAM::*******:Role/********-0496-11f0-baf6-246e96591a38",
    "scriptPath" : "dataflow-2706412-****/scripts/",
    "logPath" : "dataflow-2706412-****/sparkHistoryLogs/"
  },
  "status" : "READY",
  "startDate" : "2025-03-20T17:27:17+09:00",
  "createdDate" : "2025-03-20T17:27:17+09:00",
  "runningTime" : 0,
  "parsedParameters" : [ ],
  "type" : "JOB"
}