createWorkflow

인쇄
공유
PDF

기사 요약

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

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

워크플로를 생성합니다.

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

요청

요청 바디

파라미터명	필수 여부	타입	제약 사항	설명
name	Yes	String	- 영문자, 언더바( _ )로 시작 - 영문자, 숫자, 언더바( _ ), 하이픈( - ) 사용 가능 - 최소 3자 최대 20자로 입력	작업 이름
nodes[].id	Yes	String		노드 ID
nodes[].name	Yes	String		노드 이름
nodes[].type	Yes	String	TRIGGER, JOB	노드 타입
nodes[].parentNodeIds	Yes	String		상위 노드 ID
nodes[].triggerRule	No	String		트리거 노드 옵션
nodes[].jobCondition	Object	작업 실행 옵션

응답

필드명	타입	설명
workflowId	String	워크플로 ID
name	String	워크플로 이름
nodes[].id	String	노드 ID
nodes[].name	String	노드 이름
nodes[].type	String	노드 타입
nodes[].parentNodeIds	String	상위 노드 ID
nodes[].triggerRule	String	트리거 노드 옵션
nodes[].jobCondition	Object	작업 실행 옵션
nodes[].isValid	Boolean	삭제 여부
createdDate	String	작업 생성일
updatedDate	String	최종 업데이트
isTemp	Boolean	임시저장 여부

응답 Status

HTTP Status	Desc
201	Created(생성 완료)
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
500	Internal Server Error

예시

요청 예시

POST /api/v1/workflows

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}

{
  "isTemp": false,
  "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"
    }
  ]
}

응답 예시

{
  "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-10T14:16:01+09:00",
  "isTemp": false
}

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

What's Next

updateWorkflow

요청
응답
예시