Chen, Junjie a03981f7be DCS API 20230220 Version

Reviewed-by: Bobkova, Natalia <natalia.bobkova@t-systems.com>
Co-authored-by: Chen, Junjie <chenjunjie@huawei.com>
Co-committed-by: Chen, Junjie <chenjunjie@huawei.com>

2024-04-22 14:08:39 +00:00

15 KiB

Raw Permalink Blame History

Deleting a Task in the Task Center

Function

This API is used to delete a task in the task center.

URI

DELETE /v2/{project_id}/tasks/{task_id}

**Table 1** Path Parameters
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

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
message	No	String	Deletion result.

Response Parameters

Status code: 400

**Table 3** Response body parameters
Parameter	Type	Description
error_msg	String	Error message. Maximum: 1024
error_code	String	Error code. Maximum: 9
error_ext_msg	String	Extended error information. This parameter is not used currently and is set to null. Maximum: 1024

Status code: 401

**Table 4** Response body parameters
Parameter	Type	Description
error_msg	String	Error message. Maximum: 1024
error_code	String	Error code. Maximum: 9
error_ext_msg	String	Extended error information. This parameter is not used currently and is set to null. Maximum: 1024

Status code: 403

**Table 5** Response body parameters
Parameter	Type	Description
error_msg	String	Error message. Maximum: 1024
error_code	String	Error code. Maximum: 9
error_ext_msg	String	Extended error information. This parameter is not used currently and is set to null. Maximum: 1024

Status code: 404

**Table 6** Response body parameters
Parameter	Type	Description
error_msg	String	Error message. Maximum: 1024
error_code	String	Error code. Maximum: 9
error_ext_msg	String	Extended error information. This parameter is not used currently and is set to null. Maximum: 1024

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
error_msg	String	Error message. Maximum: 1024
error_code	String	Error code. Maximum: 9
error_ext_msg	String	Extended error information. This parameter is not used currently and is set to null. Maximum: 1024

Example Requests

POST 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.

Parent topic: Background Task Management

15 KiB Raw Permalink Blame History