updateJobExecutionConfig

VPC環境で利用できます。

ジョブ実行オプションを更新します。

リクエスト

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

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

リクエストヘッダ

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

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

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

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

リクエストボディ

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

フィールド	タイプ	必須の有無	説明
`jobCondition`	Object	Required	ジョブ実行設定内部で省略されたフィールドは既存の実行設定を維持
`jobCondition.numWorker`	Integer	Optional	ワーカー数 2~10
`jobCondition.timeout`	Integer	Optional	実行タイムアウト(分) 1~1440
`jobCondition.nrn`	String	Optional	ジョブに対する NAVERクラウドプラットフォームリソースの識別値
`jobCondition.scriptPath`	String	Optional	ジョブ実行スクリプトの保存先パス変更すると、保存されているスクリプトが新しいパスに移動
`jobCondition.logPath`	String	Optional	ジョブの実行履歴の保存先パス
`jobCondition.parameters`	Object	Optional	ジョブパラメータ(`SCRIPT`ジョブ専用) キー・値形式の文字列マップ渡すと、保存されているパラメータ全体をリクエスト値で置き換える(キーの追加や削除が可能)

リクエスト例

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

curl --location --request PUT '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,
        "timeout": 720,
        "parameters": {
            "target_date": "2025-03-22",
            "input_path": "aitems/sales/",
            "output_format": "parquet"
        }
    }
}'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`jobId`	String	-	ジョブ ID
`name`	String	-	ジョブ名
`type`	String	-	ジョブタイプ `VISUAL` \| `SCRIPT`
`status`	String	-	ジョブの状態 `READY` `READY`: ジョブが実行可能
`maxConcurrentRuns`	Integer	-	最大同時実行回数
`nodes`	Array	-	ジョブのノード情報 ETLJobNodeを参照
`runCondition`	Object	-	ジョブ実行オプション
`runCondition.numWorker`	Integer	-	ワーカー数 2~10
`runCondition.timeout`	Integer	-	実行タイムアウト(分) 1~1440
`runCondition.nrn`	String	-	ジョブに対する NAVERクラウドプラットフォームリソースの識別値
`runCondition.scriptPath`	String	-	ジョブ実行スクリプトの保存先パス
`runCondition.logPath`	String	-	ジョブの実行履歴の保存先パス
`runCondition.parameters`	Object	-	ジョブに保存されているデフォルトのパラメータキー・値形式の文字列マップ
`createdDate`	String	-	ジョブの作成日時 ISO 8601形式(UTC+9を含む)
`updatedDate`	String	-	ジョブの更新日時 ISO 8601形式(UTC+9を含む)

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

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

レスポンス例

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

{
    "jobId": "5Yns7J******",
    "name": "daily_sales_job",
    "type": "SCRIPT",
    "status": "READY",
    "maxConcurrentRuns": 3,
    "nodes": [],
    "runCondition": {
        "numWorker": 4,
        "timeout": 720,
        "nrn": "nrn:PUB:IAM::*******:Role/********",
        "scriptPath": "dataflow-2706412-****/scripts/",
        "logPath": "dataflow-2706412-****/sparkHistoryLogs/",
        "parameters": {
            "target_date": "2025-03-22",
            "input_path": "aitems/sales/",
            "output_format": "parquet"
        }
    },
    "createdDate": "2025-03-21T10:02:02+09:00",
    "updatedDate": "2025-03-22T09:15:40+09:00"
}