Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ Task Center/ Canceling a Scheduled Task
Updated on 2025-07-11 GMT+08:00
View PDF

Canceling a Scheduled Task

Function

This API is used to cancel a scheduled task. Before calling this API:

URI

DELETE /v3/{project_id}/scheduled-jobs

Table 1 URI parameter

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.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition:

User token. To obtain this value, call the IAM API for obtaining a user token.

The value of X-Subject-Token in the response header is the token value.

Constraints:

N/A

Range:

N/A

Default value:

N/A

X-Language

No

String

Definition:

Request language type.

Constraints:

N/A

Range:

  • en-us

  • zh-cn

Default value:

en-us
Table 3 Request body parameter

Parameter

Mandatory

Type

Description

job_ids

Yes

Array of strings

Task ID.

Response Parameters

Status code: 200

Table 4 Response body parameter

Parameter

Type

Description

job_ids

Array of strings

Task ID for canceling a scheduled task.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Canceling a scheduled task

DELETE https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/scheduled-jobs
{
  "job_ids" : [ "56d3c1138dcf4f1da73b0170700c78d0" ]
}

Example Response

Status code: 200

Success.

{
  "job_ids" : [ "56d3c1138dcf4f1da73b0170700c78d0" ]
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Task Center