Delete task run

Prev Next

Available in VPC

Use this when you want to delete a task model run that you no longer use or that is unnecessary.

The deletion conditions for a run are as follows.

Deletion availability Run status
Available
  • registered: registered
  • completed: available
  • failed: failed
Unavailable
  • pending: pending
  • in_progress: creating
Note

If the deletion is not possible, you will receive an error message. Try again under conditions where deletion is possible.

Request

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

Method URI
DELETE /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 DELETE '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

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