Create task run
    • PDF

    Create task run

    • PDF

    Article summary

    Available in VPC

    Create a new task model run.

    When you request to create a run, the creation process will proceed according to the following sequence.

    OrderCreation statusDescription
    Step 1registered: registeredStatus where the creation job is registered in the NCLUE system
    • It is the status before the start of the job, and you can Delete run to cancel the job
    Step 2pending: pendingStatus where the creation job is queued in the system
    Step 3in_progress: creatingStatus where the creation job is running on the server
    Step 4
    • complete: available
    • failed: failure
    Status where the creation job has been completed
    • If the creation is successful, the status will be complete, and it can be used normally
    • If the creation fails due to an error that occurred during the operation, the status will be failed and it can't be used
    Note

    The duration of each job when creating a run depends on the amount of data and service's available resources. To check the progress of the creation, call the Get task run API and check the status field in the response body.

    Request

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

    MethodURI
    POST/task-runs

    Request headers

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

    Request body

    You can include the following data in the body of your request:

    FieldTypeRequiredDescription
    nameStringRequiredTask name
    • 1-100 characters
    task_idStringRequiredTask ID to apply
    feature_idStringRequiredID of the feature applied to the task
    result_bucketStringOptionalName of the Object Storage bucket where the job result will be stored
    result_file_pathStringOptionalFile path in result_bucket to store the job result
    • File paths containing the following special characters can't be entered
      • &$@=;:+,?*\{}^%`[]<>~#|"'
      • Characters with ASCII codes 0 to 31 and 128 to 255

    Request example

    The request example is as follows:

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

    Response

    This section describes the response format.

    Response body

    The response body includes the following data:

    FieldTypeRequiredDescription
    run_idString-Run ID
    run_nameString-Run name
    task_idString-Task ID to apply
    task_nameString-Task name to apply
    feature_idString-ID of the feature applied to the task
    feature_nameString-Name of the feature applied to the task
    created_atString-Task creation request date and time (ISO 8601 format)
    result_bucketString-Name of the Object Storage bucket where the job result will be stored
    result_file_pathString-File path in Object Storage where the job result will be stored

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

    Was this article helpful?

    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.