Get task list

Prev Next

Available in VPC

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

Request

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

Method URI
GET /tasks

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/tasks?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 tasks retrieved
tasks Array - Task list

tasks

The following describes tasks.

Field Type Required Description
task_id String - Task ID
task_name String - Task name
status String - Task status
  • registered | pending | in_progress | completed | failed
    • registered: registered
    • pending: pending
    • in_progress: creating
    • completed: available
    • failed: failed
created_at String - Task creation request date and time (ISO 8601 format)
completed_at String - Task creation completion date and time (ISO 8601 format)
train_feature_id String - Feature ID to apply to train correct answer data
train_feature_name String - Feature name to apply to train correct answer data
train_bucket String - Bucket name of Object Storage where the train correct answer data file is stored
train_file_path String - Train correct answer data file path in train_bucket
test_feature_id String - Feature ID to apply to test correct answer data
test_feature_name String - Feature name to apply to test correct answer data
test_bucket String - Bucket name of Object Storage where the test correct answer data file is stored
test_file_path String - Test correct answer data file path in test_bucket
AUROC Number - Performance of the task model
  • 0-1
  • Calculated as the area under the ROC curve
line_count Integer - Number of lines of the feature applied to the task
  • If you use both the train and test correct answer data, sum the number of lines for the two features applied to each data
disk_usage Integer - Capacity (byte) of 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": 5,
    "tasks": [
        {
            "task_id": "3179664c-****-****-****-af6354344018",
            "task_name": "YOUR_TASK_NAME",
            "status": "completed",
            "created_at": "2024-11-22T08:50:51",
            "completed_at": "2024-11-22T08:52:23",
            "train_feature_id": "28bd06bb-****-****-****-9f2d6a9c3313",
            "train_feature_name": "YOUR_FEATURE_NAME",
            "train_bucket": "YOUR_BUCKET_NAME",
            "train_file_path": "path/filename",
            "test_feature_id": null,
            "test_feature_name": null,
            "test_bucket": null,
            "test_file_path": null,
            "AUROC": "0.7587277915975462",
            "line_count": 93734,
            "disk_usage": 42582684,
            "fail_message": null
        },
        // (Omitted)
    ]
}