- Print
- PDF
Delete task run
- Print
- PDF
Available in Classic and VPC
Delete a task model run.
Use this when you want to delete a task run that you no longer use or that is unnecessary. Deletion may not be possible depending on the current status the task run.
Check deletion condition
Task run status | |
---|---|
Deletion available | registered registeredcompleted availablefailed failed |
Deletion unavailable | pending pendingin_progress creating |
If the deletion is not possible, you will receive an error message. After checking the error message, proceed under the conditions that allow deletion.
Request
This section describes the request format. The method and URI are as follows:
Method | URI |
---|---|
DELETE | /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
|
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 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"
}
Failure
For examples of responses in the event of a failed call, see Response status codes.