Get task run list

Prev Next

Available in VPC

Get the list of created task model runs. You can check the detailed information of all retrieved runs.

Request

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

Method URI
GET /task-runs

Request headers

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

Request query parameters

The following describes the parameters.

Field Type Required Description
index Integer Optional Start location of the list
  • Default: 0
limit Integer Optional List output limit value
  • 1-100 (default: 20)

Request example

The request example is as follows:

curl --location --request GET 'https://nclue.apigw.ntruss.com/api/v1/task-runs?index=0&limit=20' \
--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
index Integer - Start location of the list
limit Integer - List output limit value
total Integer - Number of runs retrieved
runs Array - Run list

runs

The following describes runs.

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:

{
    "index": 0,
    "limit": 20,
    "total": 3,
    "runs": [
        {
            "run_id": "ef667a87-****-****-****-88fb69a9aff7",
            "run_name": "YOUR_RUN_NAME",
            "task_id": "3179664c-****-****-****-af6354344018",
            "task_name": "YOUR_TASK_NAME",
            "feature_id": "28bd06bb-****-****-****-9f2d6a9c3313",
            "feature_name": "YOUR_FEATURE_NAME",
            "status": "completed",
            "created_at": "2024-11-22T08:54:46",
            "completed_at": "2024-11-22T08:55:22",
            "result_bucket": "YOUR_BUCKET_NAME",
            "result_file_path": "path/filename",
            "line_count": 93734,
            "fail_message": null
        },
        // (Omitted)
    ]
}