Deleting a Task in the Task Center
Function
This API is used to delete a task in the task center.
Calling Method
For details, see Calling APIs.
URI
DELETE /v2/{project_id}/tasks/{task_id}
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Project ID. For details, see Obtaining a Project ID. |
| task_id | Yes | String | Background task ID. |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| message | No | String | Deletion result. |
Response Parameters
Status code: 200
Background task deleted successfully.
Status code: 400
| Parameter | Type | Description |
|---|---|---|
| error_msg | String | Error message. |
| error_code | String | Error code. |
| error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. |
Status code: 401
| Parameter | Type | Description |
|---|---|---|
| error_msg | String | Error message. |
| error_code | String | Error code. |
| error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. |
Status code: 403
| Parameter | Type | Description |
|---|---|---|
| error_msg | String | Error message. |
| error_code | String | Error code. |
| error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. |
Status code: 404
| Parameter | Type | Description |
|---|---|---|
| error_msg | String | Error message. |
| error_code | String | Error code. |
| error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. |
Status code: 500
| Parameter | Type | Description |
|---|---|---|
| error_msg | String | Error message. |
| error_code | String | Error code. |
| error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. |
Example Requests
DELETE https://{dcs_endpoint}/v2/{project_id}/tasks/{task_id} Example Responses
None
Status Codes
| Status Code | Description |
|---|---|
| 200 | Background task deleted successfully. |
| 400 | Invalid request. |
| 401 | Invalid authentication information. |
| 403 | Request rejected. |
| 404 | The requested resource could not be found. |
| 500 | Internal service error. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.