Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ Task Center/ Deleting a Scheduled Task Record
Updated on 2024-09-11 GMT+08:00
View PDF
Share

Deleting a Scheduled Task Record

Function

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

URI

DELETE /v3/{project_id}/instance/{instance_id}/scheduled-jobs

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.

instance_id

Yes

String

Instance ID, which is compliant with the UUID format.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

It can be obtained by calling the IAM API used to obtain a user token.

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

X-Language

No

String

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

Values:

  • en-us
  • zh-cn
Table 3 Request body parameter

Parameter

Mandatory

Type

Description

job_id

Yes

String

Task ID.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

result

Boolean

Returned result.

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

Deleting a scheduled task record

DELETE https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instance/34cbc6c13e074761a0f893e9f30e6edfin07/scheduled-jobs

{
  "job_id" : "54c219a29a5f477ba69e36d0116d05d7"
}

Example Response

Status code: 200

Success.

{
  "result" : true
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Task Center