MENU
      Task Run 생성

        Task Run 생성


        기사 요약

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

        새로운 Task Model Run을 생성합니다.

        Run 생성을 요청하면 다음 순서에 따라 생성 작업이 진행됩니다.

        순서생성 상태설명
        Step 1registered: 등록됨생성 작업이 NCLUE 시스템에 등록된 상태
        • 작업 시작 전 상태로, Run을 삭제하여 작업 취소 가능
        Step 2pending: 대기 중생성 작업이 시스템 대기열에 올라간 상태
        Step 3in_progress: 생성 중생성 작업이 서버에서 실행 중인 상태
        Step 4
        • complete: 사용 가능
        • failed: 실패
        생성 작업이 완료된 상태
        • 생성 성공 시 complete 상태가 되며, 정상적으로 사용 가능
        • 작업 중 발생한 오류로 인해 생성 실패 시 failed 상태가 되며, 사용 불가
        참고

        Run 생성 시 각 작업 시간은 데이터 양과 서비스 가용 자원 상황에 따라 달라집니다. 생성 진행 상태는 Task Run 조회 API를 호출하여 응답 바디의 status 필드에서 확인해 주십시오.

        요청

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

        메서드URI
        POST/task-runs

        요청 헤더

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

        요청 바디

        요청 바디에 대한 설명은 다음과 같습니다.

        필드타입필수 여부설명
        nameStringRequiredTask 이름
        • 1~100자
        task_idStringRequired적용하려는 Task ID
        feature_idStringRequiredTask에 적용된 Feature ID
        result_bucketStringOptional작업 결과를 저장할 Object Storage 버킷 이름
        result_file_pathStringOptionalresult_bucket 내 작업 결과를 저장할 파일 경로
        • 다음 특수 문자가 포함된 파일 경로는 입력 불가
          • &$@=;:+,?*\{}^%`[]<>~#|"'
          • ASCII 코드가 0~31, 128~255인 문자

        요청 예시

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

        curl --location --request POST 'https://nclue.apigw.ntruss.com/api/v1/task-runs' \
        --header 'X-NCP-APIGW-TIMESTAMP: {Timestamp}' \
        --header 'X-NCP-IAM-ACCESS-KEY: {Access Key}' \
        --header 'X-NCP-APIGW-SIGNATURE-V2: {API Gateway Signature}' \
        --data '{
            "name": "YOUR_RUN_NAME",
            "task_id": "3179664c-****-****-****-af6354344018",
            "feature_id": "e48585fd-****-****-****-754aa0b7ba82",
            "result_bucket": "YOUR_BUCKET_NAME",
            "result_file_path": "path/filename"
        }'
        Shell

        응답

        응답 형식을 설명합니다.

        응답 바디

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

        필드타입필수 여부설명
        run_idString-Run ID
        run_nameString-Run 이름
        task_idString-적용하려는 Task ID
        task_nameString-적용하려는 Task 이름
        feature_idString-Task에 적용된 Feature ID
        feature_nameString-Task에 적용된 Feature 이름
        created_atString-Task 생성 요청 일시(ISO 8601 형식)
        result_bucketString-작업 결과를 저장할 Object Storage 버킷 이름
        result_file_pathString-작업 결과를 저장할 Object Storage 버킷의 파일 경로

        응답 상태 코드

        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",
            "created_at": "2024-11-26T14:53:32+09:00",
            "result_bucket": "YOUR_BUCKET_NAME",
            "result_file_path": "path/filename"
        }
        JSON

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

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.