Get task run

Article summary

Did you find this summary helpful?

Thank you for your feedback

Available in Classic and VPC

Get the details of a created task model run.

You can check the progress of the task model run you requested to create, the feature applied to the task model, and the Object Storage bucket where the execution result file will be stored.

Request

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

Method	URI
GET	/api/v1/task-runs/{run_id}

Request headers

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

Request path parameters

You can use the following path parameters with your request:

Field	Type	Required	Description
`run_id`	String	Required	Task run ID Can be checked from the response body of Get task run list

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	-	Task Run ID
`run_name`	String	-	Name of task run entered by the user
`task_id`	String	-	ID of the task to check performance, which is entered when creating the task run
`task_name`	String	-	Name of task to check performance
`feature_id`	String	-	ID of the feature applied to the task, which is entered when creating the task run
`feature_name`	String	-	Name of the feature applied to the task
`status`	String	-	Creation type `registered` \| `pending` \| `in_progress` \| `completed` \| `failed` `registered`: registered `pending`: pending `in_progress`: creating `completed`: available `failed`: failed
`created_at`	String	-	Task run creation request date (ISO 8601 format)
`completed_at`	String	-	Task run creation job completion date (ISO 8601 format)
`result_bucket`	String	-	Name of the Object Storage bucket to store the task run job results
`result_file_path`	String	-	File path to save the results in the result_bucket bucket
`line_count`	Integer	-	Number of lines of the feature used to create task run
`fail_message`	String	-	Message upon creation failure. See Troubleshooting NCLUE

Response example

The response example is as follows:

Succeeded

The following is a sample response upon a successful call.

{
    "run_id":"9e6fecc9-0079-4c5e-a0c6-f387e6221afa",
    "run_name":"Estimate of users interested in purchasing pet food",
    "task_id":"b5e742f1-0558-465a-8485-3b7808b0e125",
    "task_name":"Prediction model for pet food purchase interest",
    "feature_id":"79eb85b5-8ec5-4e1a-8617-64a1977c8062",
    "feature_name":"Shopping behavior sequence - 2024",
    "status":"completed",
    "created_at":"2024-11-03T15:02:24",
    "completed_at":"2024-11-03T15:03:08",
    "result_bucket":"your.bucket.name",
    "result_file_path":"petfood_predict.tsv",
    "line_count": 1209478,
    "fail_message":null
}

Failure

For examples of responses in the event of a failed call, see Response status codes.

Was this article helpful?

What's Next

Get task run list

Table of contents

Request
Response