getWorkflows

VPC 환경에서 이용 가능합니다.

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

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드	URI
GET	/api/v1/workflows

요청 헤더

Data Flow API에서 공통으로 사용하는 헤더에 대한 정보는 Data Flow 요청 헤더를 참조해 주십시오.

요청 쿼리 파라미터

요청 쿼리 파라미터에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`page`	Integer	Optional	페이지 번호 0~N (기본값: 0)
`limit`	Integer	Optional	페이지 출력 수 0~N (기본값: 1000)

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request GET 'https://dataflow.apigw.ntruss.com/api/v1/workflows?page=0&limit=1000' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`list`	Array	-	워크플로 목록
`count`	Integer	-	응답 결과 수
`page`	Integer	-	페이지 번호
`limit`	Integer	-	페이지 출력 수

`list`

list에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`workflowId`	String	-	워크플로 아이디
`name`	String	-	워크플로 이름
`createdDate`	String	-	워크플로 생성 일시 ISO 8601 형식(UTC+9 포함)
`updatedDate`	String	-	워크플로 수정 일시 ISO 8601 형식(UTC+9 포함)
`lastExecutionDate`	String	-	워크플로 마지막 실행 일시 ISO 8601 형식(UTC+9 포함)
`isTemp`	Boolean	-	임시 저장 여부 `true` \| `false` `true`: 임시 저장 `false`: 즉시 완료(임시 저장 안 함)
`triggerRuleType`	String	-	트리거 실행 옵션 유형 `RECURRING` \| `ONE_TIME` \| `NONE` `RECURRING`: 주기 실행 `ONE_TIME`: 특정일 실행 `NONE`: 실행 옵션 없음
`nodes`	Array	-	노드 정보
`resourceId`	String	-	리소스 아이디 워크플로 아이디와 동일
`disabled`	Boolean	-	리소스 조회 권한 여부

`nodes`

nodes에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`id`	String	-	노드 아이디 `type`에 따라 `triggerId` 또는 `jobId` 값 표시
`name`	String	-	노드 이름 `type`에 따라 트리거 이름 또는 작업 이름 표시
`type`	String	-	노드 유형 `TRIGGER` \| `JOB`
`parentNodeIds`	Array	-	상위 노드 아이디 목록 작업 노드 오브젝트는 트리거 노드의 아이디 표시 트리거 노드 오브젝트는 빈 값 표시
`triggerRule`	String	-	트리거 노드 실행 옵션 정보 `RECURRING` \| `ONE_TIME` \| `NONE` `RECURRING`: 주기 실행 `ONE_TIME`: 특정일 실행 `NONE`: 실행 옵션 없음
`isValid`	Boolean	-	노드 삭제 여부(노드 사용 가능 여부) `true` \| `false` `true`: 미삭제(사용 가능) `false`: 삭제(사용 불가)
`jobCondition`	Object	-	작업 실행 옵션 정보
`jobCondition.workerType`	String	-	워커 유형 `DATAFLOW` (기본값)
`jobCondition.numWorker`	Integer	-	워커 수 2 (기본값)
`jobCondition.timeout`	Integer	-	실행 타임아웃(분) 작업을 한 번 실행할 때 작업 결과를 기다리는 시간 0~1440 (기본값: 360)
`jobCondition.nrn`	String	-	작업에 대한 네이버 클라우드 플랫폼 리소스 식별 값
`jobCondition.scriptPath`	String	-	작업 실행 스크립트 저장 경로
`jobCondition.logPath`	String	-	작업 실행 이력 저장 경로

응답 상태 코드

Data Flow API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Data Flow API 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
  "list": [
    {
      "workflowId": "3tfNLP******",
      "name": "workflow001",
      "createdDate": "2025-03-24T14:46:24+09:00",
      "updatedDate": "2025-03-24T14:46:24+09:00",
      "isTemp": false,
      "triggerRuleType": "RECURRING",
      "nodes": [
        {
          "id": "gqigvH******",
          "name": "job001",
          "type": "JOB",
          "parentNodeIds": [
            "8bjF7E******"
          ],
          "jobCondition": {
            "workerType": "DEFAULT",
            "numWorker": 3,
            "timeout": 360,
            "nrn": "nrn:PUB:IAM::*******:Role/********-0496-11f0-baf6-246e96591a38",
            "scriptPath": "dataflow-2706412-****/scripts/",
            "logPath": "dataflow-2706412-****/sparkHistoryLogs/"
          }
        },
        {
          "id": "8bjF7E******",
          "name": "trigger001",
          "type": "TRIGGER",
          "parentNodeIds": [],
          "triggerRule": "RECURRING"
        }
      ],
      "resourceId": "3tfNLP******",
      "disabled": false
    }
  ],
  "count": 1,
  "page": 0,
  "limit": 1000
}