createJob
    • PDF

    createJob

    • PDF

    기사 요약

    작업을 생성합니다.

    POST https://dataflow.apigw.ntruss.com/api/v1/jobs
    

    요청

    요청 바디

    파라미터명필수 여부타입제약 사항설명
    nameYesString- 영문자, 언더바( _ )로 시작
    - 영문자, 숫자, 언더바( _ ), 하이픈( - ) 사용 가능
    - 최소 3자 최대 20자로 입력
    작업 이름
    nodesYesETLJobNode작업 노드

    응답

    필드명타입설명비고
    jobIdString작업 ID
    nameString작업 이름
    typeString작업 타입
    statusString작업 상태
    nodes[].idNumber노드 ID
    nodes[].nameString노드 이름
    nodes[].typeString노드 타입
    nodes[].parentNodeIdsArray상위 노드 ID
    runCondtion.workerTypeStringWorker 타입
    runCondition.numWorkerNumberWorker 개수
    runCondition.timeoutNumber실행 타임아웃
    runCondition.nrnString정책 NRN
    runCondition.scriptPathString실행 스크립트 저장 경로
    runCondition.logPathString실행 로그 저장 경로
    createdDateString작업 생성일
    updatedDateString최종 업데이트

    응답 Status

    HTTP StatusDesc
    201Created(생성 완료)
    400Bad Request
    401Unauthorized
    403Forbidden
    404Not Found
    500Internal 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",
      "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",
      "description": "",
      "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
    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.