updateJob

Available in VPC

Edit a job. ## Request This section describes the request format. The method and URI are as follows:

Method	URI
PATCH	/api/v1/jobs/{jobId}

Request headers

For information about the headers common to all Data Flow APIs, see Data Flow request headers.

Request path parameters

You can use the following path parameters with your request:

Field	Type	Required	Description
`jobId`	String	Required	Job ID See getJobs.

Request body

You can include the following data in the body of your request:

Field	Type	Required	Description
`type`	String	Required	Job type `VISUAL` \| `SCRIPT`
`name`	String	Optional	Job name Enter 3-100 characters by combining English letters, numbers, and special characters "_" and "-". It must start with an English letter or "-".
`maxConcurrentRuns`	Integer	Optional	Maximum number of concurrent executions
`jobCondition`	Object	Optional	Job execution settings
`jobCondition.numWorker`	Integer	Optional	Number of workers 2-10
`jobCondition.timeout`	Integer	Optional	Execution timeout (minute) 1-1440
`jobCondition.nrn`	String	Optional	NAVER Cloud Platform resource identification value for job
`jobCondition.scriptPath`	String	Optional	Job execution script storage path
`jobCondition.logPath`	String	Optional	Job execution history storage path
`nodes`	Array	Optional	Job node information See ETLJobNode.
`code`	String	Optional	SCRIPT job execution code

Request example

The request example is as follows:

curl --location --request PATCH 'https://dataflow.apigw.ntruss.com/api/v1/jobs/gqigvH******' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
  "type": "VISUAL",
  "name": "job001",
  "maxConcurrentRuns": 3,
  "jobCondition": {
    "numWorker": 2,
    "timeout": 360,
    "nrn": "nrn:PUB:IAM::*******:Role/********",
    "scriptPath": "dataflow-2706412-****/scripts/",
    "logPath": "dataflow-2706412-****/sparkHistoryLogs/"
  },
  "nodes": [
        {
          "type": "SOURCE_OBS",
          "id": 169777*******,
          "name": "Object Storage",
          "parentNodeIds": [],
          "regionNo": "1",
          "bucketName": "aitems",
          "prefix": "dataflow1",
          "dataType": "CSV",
          "fieldList": [
            {
              "name": "id",
              "type": "string"
            },
            {
              "name": "name",
              "type": "string"
            },
            {
              "name": "description",
              "type": "string"
            }
          ]
        },
        {
          "type": "TRANSFORM_FILTER",
          "id": 169777*******,
          "name": "Filters",
          "parentNodeIds": [
            169777*******
          ],
          "filterType": "AND",
          "filterConditionList": [
            {
              "name": "name",
              "operator": "EQ",
              "value": "A"
            }
          ]
        },
        {
          "type": "TARGET_OBS",
          "id": 169777*******,
          "name": "Object Storage",
          "parentNodeIds": [
            169777*******
          ],
          "regionNo": "1",
          "bucketName": "aitems",
          "prefix": "dataflow1",
          "dataType": "CSV",
          "updateType" : "OVERWRITE",
          "fieldList": [
            {
              "name": "id",
              "type": "string"
            },
            {
              "name": "name",
              "type": "string"
            },
            {
              "name": "description",
              "type": "string"
            }
          ]
        }
      ]
}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field	Type	Required	Description
`jobId`	String	-	Job ID
`name`	String	-	Job name
`type`	String	-	Job type `DATAFLOW` (default)
`status`	String	-	Job status `RUNNABLE` \| `RUNNING` \| `DELETED` \| `UNKNOWN` \| `DRAFT` \| `STOPPED` \| `EDITING` `RUNNABLE`: Job execution available `RUNNING`: Job execution in progress `DELETED`: Job being deleted or deletion completed `UNKNOWN`: Other `DRAFT`: Job edit incomplete `STOPPED`: Job being stopped `EDITING`: Job being edited (validation required)
`nodes`	Array	-	Job node information See ETLJobNode.
`runCondition`	Object	-	Job execution option
`runCondition.numWorker`	Integer	-	Number of workers 2-10
`runCondition.timeout`	Integer	-	Execution timeout (minute) 1-1440
`runCondition.nrn`	String	-	NAVER Cloud Platform resource identification value for job
`runCondition.scriptPath`	String	-	Job execution script storage path
`runCondition.logPath`	String	-	Job execution history storage path
`createdDate`	String	-	Job creation date and time ISO 8601 format (including UTC+9)
`updatedDate`	String	-	Job modification date and time ISO 8601 format (including UTC+9)

Response status codes

For information about the HTTP status codes common to all Data Flow APIs, see Data Flow response status codes.

Response example

The response example is as follows:

{
      "jobId": "gqigvH******",
      "name": "job001",
      "description": "",
      "type": "DATAFLOW",
      "status": "RUNNABLE",
      "nodes": [
        {
          "type": "SOURCE_OBS",
          "id": 169777*******,
          "name": "Object Storage",
          "parentNodeIds": [],
          "regionNo": "1",
          "bucketName": "aitems",
          "prefix": "dataflow1",
          "dataType": "CSV",
          "fieldList": [
            {
              "name": "id",
              "type": "string",
              "properties": []
            },
            {
              "name": "name",
              "type": "string",
              "properties": []
            },
            {
              "name": "description",
              "type": "string",
              "properties": []
            }
          ]
        },
        {
          "type": "TRANSFORM_FILTER",
          "id": 169777*******,
          "name": "Filters",
          "parentNodeIds": [
            169777*******
          ],
          "filterType": "AND",
          "filterConditionList": [
            {
              "name": "name",
              "operator": "EQ",
              "value": "A"
            }
          ]
        },
        {
          "type": "TARGET_OBS",
          "id": 169777*******,
          "name": "Object Storage",
          "parentNodeIds": [
            169777*******
          ],
          "regionNo": "1",
          "bucketName": "aitems",
          "prefix": "dataflow1",
          "dataType": "CSV",
          "updateType" : "OVERWRITE",
          "fieldList": [
            {
              "name": "id",
              "type": "string",
              "properties": []
            },
            {
              "name": "name",
              "type": "string",
              "properties": []
            },
            {
              "name": "description",
              "type": "string",
              "properties": []
            }
          ]
        }
      ],
      "runCondition": {
        "numWorker": 2,
        "timeout": 360,
        "nrn": "",
        "scriptPath": "dataflow-****/scripts/",
        "logPath": "dataflow-****/sparkHistoryLogs/"
      },
      "createdDate": "2025-03-19T15:03:42+09:00",
      "updatedDate": "2025-03-20T13:07:34+09:00"
    }

Documentation Index