getJobs

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

작업 목록을 조회합니다.

요청

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

메서드	URI
GET	/api/v1/jobs

요청 헤더

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

요청 쿼리 파라미터

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

필드	타입	필수 여부	설명
`name`	String	Optional	작업 이름
`status`	String	Optional	작업 상태 `RUNNABLE` \| `RUNNING` \| `DELETED` \| `UNKNOWN` \| `DRAFT` \| `STOPPED` \| `EDITING` `RUNNABLE`: 작업 실행 가능 `RUNNING`: 작업 실행 중 `DELETED`: 작업 삭제 중 또는 삭제 완료 `UNKNOWN`: 기타 `DRAFT`: 작업 편집 미완료 `STOPPED`: 작업 정지 중 `EDITING`: 작업 수정 중(유효성 검증 필요)
`page`	Integer	Optional	페이지 번호 0~N (기본값: 0)
`limit`	Integer	Optional	페이지 출력 수 0~N (기본값: 1000)

요청 예시

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

curl --location --request GET 'https://dataflow.apigw.ntruss.com/api/v1/jobs?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에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`jobId`	String	-	작업 아이디
`name`	String	-	작업 이름
`type`	String	-	작업 유형 `DATAFLOW` (기본값)
`status`	String	-	작업 상태 `RUNNABLE` \| `RUNNING` \| `DELETED`\| `DRAFT` \| `EDITING`\| `STOPPED` `RUNNABLE`: 실행 가능 `RUNNING`: 실행 중 `DELETED`: 삭제 중 또는 삭제 `DRAFT`: 편집 미완료 `EDITING`: 수정 중(유효성 검증 필요) `STOPPED`: 정지 중 또는 정지
`lastExecutionStatus`	String	-	마지막 작업 실행 상태 `COMPLETED` \| `FAILED` \| `CANCELED` `COMPLETED`: 완료 `FAILED`: 실패 `CANCELED`: 취소
`createdDate`	String	-	작업 생성 일시 ISO 8601 형식(UTC+9 포함)
`updatedDate`	String	-	작업 수정 일시 ISO 8601 형식(UTC+9 포함)
`lastExecutionDate`	String	-	작업 마지막 실행 일시 ISO 8601 형식(UTC+9 포함)
`resourceId`	String	-	리소스 아이디 작업 아이디(`jobId`)와 동일
`disabled`	Boolean	-	리소스 조회 권한 유무

응답 상태 코드

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

응답 예시

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

{
    "list": [
        {
            "jobId": "fAjvc*******",
            "name": "job002",
            "type": "DATAFLOW",
            "status": "RUNNABLE",
            "lastExecutionStatus": "COMPLETED",
            "createdDate": "2025-03-20T08:54:03+09:00",
            "updatedDate": "2025-03-20T14:01:23+09:00",
            "lastExecutionDate": "2025-03-20T14:00:09+09:00",
            "resourceId": "fAjvc*******",
            "disabled": false
        },
        {
            "jobId": "gqigvH******",
            "name": "job001",
            "type": "DATAFLOW",
            "status": "RUNNABLE",
            "lastExecutionStatus": "COMPLETED",
            "createdDate": "2025-03-19T15:03:42+09:00",
            "updatedDate": "2025-03-20T13:07:34+09:00",
            "lastExecutionDate": "2025-03-20T13:06:05+09:00",
            "resourceId": "gqigvH******",
            "disabled": false
        }
    ],
    "count": 2,
    "page": 0,
    "limit": 1000
}