Help Center/ GaussDB(for MySQL)/ API Reference/ APIs (Recommended)/ Task Center/ Deleting a Task Record
Updated on 2023-10-18 GMT+08:00
View PDF

Deleting a Task Record

Function

This API is used to delete the record of a specific task. Before calling this API:

URI

DELETE /v3/{project_id}/jobs/{job_id}

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

job_id

Yes

String

Task ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

If the following response body is returned for calling the API used to obtain a user token, the request is successful.

After the request is processed, the value of X-Subject-Token in the message header is the token value.

X-Language

No

String

Request language type. The default value is en-us.

Value:

  • en-us
  • zh-cn

Response Parameters

Status code: 400

Table 3 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Deleting a specified task record

DELETE https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/jobs/6b00c41d-d54f-4bcb-80da-566ccedc2b5d

Example Response

Status code: 200

Success.

{ }

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Task Center