Get task run

Prev Next

Available in VPC

Get the details of a created task model run. You can check the progress of the created run, the tasks applied to the run, the features applied to the tasks, and the name of the Object Storage bucket and file path where the job results are stored. If the creation fails, you can see the error message.

Request

This section describes the request format. The method and URI are as follows:

Method URI
GET /task-runs/{run_id}

Request headers

For information about the headers common to all NCLUE APIs, see NCLUE request headers.

Request path parameters

You can use the following path parameters with your request:

Field Type Required Description
run_id String Required Run ID

Request example

The request example is as follows:

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}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
run_id String - Run ID
run_name String - Run name
task_id String - Task ID to apply
task_name String - Task name to apply
feature_id String - ID of the feature applied to the task
feature_name String - Name of the feature applied to the task
status String - Run status
  • registered | pending | in_progress | completed | failed
    • registered: registered
    • pending: pending
    • in_progress: creating
    • completed: available
    • failed: failed
created_at String - Run creation request date and time (ISO 8601 format)
completed_at String - Run creation completion date and time (ISO 8601 format)
result_bucket String - Name of the Object Storage bucket where the job result is stored
result_file_path String - Path of the result_bucket file where the job result is stored
line_count Integer - Number of lines of the feature applied to the task
fail_message String - Creation failure message

Response status codes

For response status codes common to NCLUE, see NCLUE response status codes.

Response example

The response example is as follows:

{
    "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
}