getWorkflowById
    • PDF

    getWorkflowById

    • PDF

    기사 요약

    워크플로를 조회합니다.

    GET https://dataflow.apigw.ntruss.com/api/v1/workflows/{workflowId}
    

    요청

    요청 파라미터

    파라미터명필수 여부타입제약 사항설명
    workflowIdYesString워크플로 ID

    응답

    필드명타입설명비고
    workflowIdString워크플로 ID
    nameString워크플로 이름
    nodes[].idString노드 ID
    nodes[].nameString노드 이름
    nodes[].typeString노드 타입
    nodes[].parentNodeIdsString상위 노드 ID
    nodes[].triggerRuleString트리거 노드 옵션
    nodes[].jobConditionObject작업 실행 옵션
    nodes[].isValidBoolean삭제 여부
    createdDateString워크플로 생성일
    updatedDateString최종 업데이트
    isTempBoolean임시저장 여부

    응답 Status

    HTTP StatusDesc
    200OK(조회 완료)
    400Bad Request
    401Unauthorized
    403Forbidden
    404Not Found
    500Internal Server Error

    예시

    요청 예시

    GET /api/v1/workflows/pJ1HCEI7L9ha
    
    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}
    
    

    응답 예시

    {
      "workflowId": "pJ1HCEI7L9ha",
      "name": "test-workflow2",
      "nodes": [
        {
          "id": "RpiB7okASK5W",
          "name": "cdb_pg_test",
          "type": "JOB",
          "parentNodeIds": [
            "vMcf5Gvf2x3R"
          ],
          "jobCondition": {
            "workerType": "DEFAULT",
            "numWorker": 3,
            "timeout": 360,
            "nrn": "nrn:PUB:IAM::25****4:Role/****-a9d6-****-a85d-****",
            "scriptPath": "dataflow-33-****/scripts/",
            "logPath": "dataflow-33-****/sparkHistoryLogs/"
          }
        },
        {
          "id": "vMcf5Gvf2x3R",
          "name": "awefawef",
          "type": "TRIGGER",
          "parentNodeIds": [],
          "triggerRule": "NONE"
        }
      ],
      "createdDate": "2024-07-10T14:16:01+09:00",
      "updatedDate": "2024-07-24T15:26:09+09:00",
      "isTemp": false
    }
    

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

    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.