Task Run 조회

Prev Next

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

생성한 Task Model Run의 상세 정보를 조회합니다. 생성 요청한 Run의 진행 상태, Run에 적용된 Task와 Task에 적용된 Feature, 작업 결과가 저장된 Object Storage 버킷 이름과 파일 경로를 확인할 수 있습니다. 생성 실패 시에는 오류 메시지를 확인할 수 있습니다.

요청

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

메서드 URI
GET /task-runs/{run_id}

요청 헤더

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

요청 경로 파라미터

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

필드 타입 필수 여부 설명
run_id String Required Run ID

요청 예시

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

curl --location --request GET 'https://nclue.apigw.ntruss.com/api/v1/task-runs/{run_id}' \
--header 'X-NCP-APIGW-TIMESTAMP: {Timestamp}' \
--header 'X-NCP-IAM-ACCESS-KEY: {Access Key}' \
--header 'X-NCP-APIGW-SIGNATURE-V2: {API Gateway Signature}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드 타입 필수 여부 설명
run_id String - Run ID
run_name String - Run 이름
task_id String - 적용하려는 Task ID
task_name String - 적용하려는 Task 이름
feature_id String - Task에 적용된 Feature ID
feature_name String - Task에 적용된 Feature 이름
status String - Run 상태
  • registered | pending | in_progress | completed | failed
    • registered: 등록됨
    • pending: 대기 중
    • in_progress: 생성 중
    • completed: 사용 가능
    • failed: 실패
created_at String - Run 생성 요청 일시(ISO 8601 형식)
completed_at String - Run 생성 완료 일시(ISO 8601 형식)
result_bucket String - 작업 결과가 저장된 Object Storage 버킷 이름
result_file_path String - 작업 결과가 저장된 result_bucket 내 파일 경로
line_count Integer - Task에 적용된 Feature의 라인 수
fail_message String | null - 생성 실패 메시지
  • 생성 실패 시 메시지를 반환하며, 성공 시에는 null 리턴
  • 메시지별 해결 방법은 NCLUE 문제 해결 참조

응답 상태 코드

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

응답 예시

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

{
    "run_id": "f475197f-****-****-****-faf3dd580179",
    "run_name": "YOUR_RUN_NAME",
    "task_id": "3179664c-****-****-****-af6354344018",
    "task_name": "YOUR_TASK_NAME",
    "feature_id": "e48585fd-****-****-****-754aa0b7ba82",
    "feature_name": "YOUR_FEATURE_NAME",
    "status": "completed",
    "created_at": "2024-11-26T14:53:33",
    "completed_at": "2024-11-26T14:54:01",
    "result_bucket": "YOUR_BUCKET_NAME",
    "result_file_path": "path/filename",
    "line_count": 9370,
    "fail_message": null
}