updateJob

인쇄
공유
PDF

기사 요약

이 요약이 도움이 되었나요?

의견을 보내 주셔서 감사합니다.

작업을 수정합니다.

PUT https://dataflow.apigw.ntruss.com/api/v1/jobs/{jobId}

요청

요청 파라미터

파라미터명	필수 여부	타입	제약 사항	설명
jobId	Yes	String		작업 ID

요청 바디

파라미터명	필수 여부	타입	제약 사항	설명
name	Yes	String	- 영문자, 언더바( _ )로 시작 - 영문자, 숫자, 언더바( _ ), 하이픈( - ) 사용 가능 - 최소 3자 최대 20자로 입력	작업 이름
type	Yes	String		작업 타입
nodes	Yes	ETLJobNode		작업 노드
isTemp	Yes	Boolean		임시저장 여부

응답

필드명	타입	설명
jobId	String	작업 ID
name	String	작업 이름
type	String	작업 타입
status	String	작업 상태
nodes[].id	Number	노드 ID
nodes[].name	String	노드 이름
nodes[].type	String	노드 타입
nodes[].parentNodeIds	Array	상위 노드 ID
runCondtion.workerType	String	Worker 타입
runCondition.numWorker	Number	Worker 개수
runCondition.timeout	Number	실행 Timeout
runCondition.nrn	String	정책 NRN
runCondition.scriptPath	String	실행 스크립트 저장 경로
runCondition.logPath	String	실행 로그 저장 경로
createdDate	String	작업 생성일
updatedDate	String	최종 업데이트

응답 Status

HTTP Status	Desc
200	OK(수정 완료)
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
500	Internal Server Error

예시

요청 예시

POST /api/v1/jobs

Host: dataflow.apigw.ntruss.com
x-ncp-iam-access-key: {Access key}
x-ncp-apigw-signature-v2: {API GW signature}
x-ncp-apigw-timestamp: {timestamp}

{
  "name": "data-flow",
  "description": "",
  "type": "DATAFLOW",
  "isTemp": false,
  "nodes": [
        {
          "type": "SOURCE_OBS",
          "id": 1697776914576,
          "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": 1697776942407,
          "name": "필터",
          "parentNodeIds": [
            1697776914576
          ],
          "filterType": "AND",
          "filterConditionList": [
            {
              "name": "name",
              "operator": "EQ",
              "value": "A"
            }
          ]
        },
        {
          "type": "TARGET_OBS",
          "id": 1697776948956,
          "name": "Object Storage",
          "parentNodeIds": [
            1697776942407
          ],
          "regionNo": "1",
          "bucketName": "aitems",
          "prefix": "dataflow1",
          "dataType": "CSV",
          "updateType" : "OVERWRITE",
          "fieldList": [
            {
              "name": "id",
              "type": "string"
            },
            {
              "name": "name",
              "type": "string"
            },
            {
              "name": "description",
              "type": "string"
            }
          ]
        }
      ]
}

응답 예시

{
      "jobId": "5Yns7JgRt25f",
      "name": "data-flow",
      "type": "DATAFLOW",
      "status": "RUNNABLE",
      "nodes": [
        {
          "type": "SOURCE_OBS",
          "id": 1697776914576,
          "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": 1697776942407,
          "name": "필터",
          "parentNodeIds": [
            1697776914576
          ],
          "filterType": "AND",
          "filterConditionList": [
            {
              "name": "name",
              "operator": "EQ",
              "value": "A"
            }
          ]
        },
        {
          "type": "TARGET_OBS",
          "id": 1697776948956,
          "name": "Object Storage",
          "parentNodeIds": [
            1697776942407
          ],
          "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": {
        "workerType": "DEFAULT",
        "numWorker": 2,
        "timeout": 2880,
        "nrn": "",
        "scriptPath": "dataflow-****/scripts/",
        "logPath": "dataflow-****/sparkHistoryLogs/"
      },
      "createdDate": "2023-10-20T13:45:15.000",
      "updatedDate": "2023-10-20T13:46:56.000"
    }

이 문서가 도움이 되었습니까?

What's Next

deleteJob

요청
응답
예시