getWorkflows

인쇄
공유
PDF

기사 요약

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

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

워크플로 목록을 조회합니다.

GET https://dataflow.apigw.ntruss.com/api/v1/workflows?page={page}&limit={limit}

요청

요청 파라미터

파라미터명	필수 여부	타입	제약 사항	설명
page	No	Number		페이지
limit	No	Number		페이지별 최대 개수

응답

필드명	타입	설명
list[].workflowId	String	워크플로 ID
list[].name	String	워크플로 이름
list[].createdDate	String	워크플로 생성일
list[].updatedDate	String	최종 업데이트
list[].lastExecutionDate	String	최종 실행일
list[].isTemp	Boolean	임시저장 여부
list[].triggerRuleType	String	트리거 룰 타입
list[].nodes[].id	String	노드 ID
list[].nodes[].name	String	노드 이름
list[].nodes[].type	String	노드 타입
list[].nodes[].parentNodeIds	String	상위 노드 ID
list[].nodes[].triggerRule	String	트리거 노드 옵션
list[].nodes[].jobCondition	Object	작업 실행 옵션
list[].nodes[].isValid	Boolean	삭제 여부
list[].resourceId	String	리소스 ID(워크플로 ID와 동일)
list[].disabled	String	리소스 조회 권한 여부
count	Number	총 개수
page	Number	페이지
limit	Number	페이지별 최대 개수

응답 Status

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

예시

요청 예시

GET /api/v1/workflows?page=0&limit=20

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}

응답 예시

{
  "list": [
    {
      "workflowId": "pJ1HCEI7L9ha",
      "name": "test-workflow2",
      "createdDate": "2024-07-10T14:16:01+09:00",
      "updatedDate": "2024-07-24T15:26:09+09:00",
      "isTemp": false,
      "triggerRuleType": "NONE",
      "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"
        }
      ],
      "resourceId": "pJ1HCEI7L9ha",
      "disabled": false
    },
    {
      "workflowId": "saTBhhA5A6DS",
      "name": "test-workflow",
      "createdDate": "2024-06-12T14:41:45+09:00",
      "updatedDate": "2024-07-01T18:15:35+09:00",
      "isTemp": false,
      "triggerRuleType": "NONE",
      "nodes": [
        {
          "id": "GOIlT1ccQHtq",
          "name": "cdb",
          "type": "JOB",
          "parentNodeIds": [
            "vMcf5Gvf2x3R"
          ],
          "jobCondition": {
            "workerType": "DEFAULT",
            "numWorker": 2,
            "timeout": 360,
            "nrn": "nrn:PUB:IAM::25****4:Role/****-b05d-****-bebe-****",
            "scriptPath": "dataflow-33-****/scripts/",
            "logPath": "dataflow-33-****/sparkHistoryLogs/"
          }
        },
        {
          "id": "vMcf5Gvf2x3R",
          "name": "awefawef",
          "type": "TRIGGER",
          "parentNodeIds": [],
          "triggerRule": "NONE"
        }
      ],
      "resourceId": "saTBhhA5A6DS",
      "disabled": false
    }
  ],
  "count": 2,
  "page": 0,
  "limit": 1000
}

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

What's Next

getWorkflowById

요청
응답
예시