Help Center/ Data Replication Service/ API Reference/ APIs V5.0 (in OBT)/ Task Management/ Deleting a Task with a Specified ID
Updated on 2024-10-25 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Deleting a Task with a Specified ID

Function

This API is used to delete a task with a specified ID.

Constraints

  • This API supports only the synchronization scenarios from Oracle to GaussDB Distributed, MySQL to Kafka, and GaussDB(for MySQL) to Kafka.
  • Before calling this API to delete a task, ensure that the task is in the Stopped state.
  • This API can be used only in certain regions. For details, see Endpoints.

URI

DELETE /v5/{project_id}/jobs/{job_id}

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region.

For details about how to obtain the project ID, see Obtaining a Project ID.

job_id

Yes

String

Task ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

MIME type of the request body. Use the default value application/json. For APIs used to upload objects or images, the value varies depending on the flow type.

The default value is application/json.

X-Auth-Token

Yes

String

User token obtained from IAM.

It is a response to the API for obtaining a user token. This API is the only one that does not require authentication.

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

X-Language

No

String

Request language type.

Default value: en-us

Enumerated values:

  • en-us
  • zh-cn

Response Parameters

Status code: 400

Table 3 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

Minimum length: 12

Maximum length: 12

error_msg

String

Error message.

Minimum length: 1

Maximum length: 512

Example Request

Deleting a task with a specified ID

https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs/dc6016cf-f3b6-4c2d-b4d7-5084b0fjb20r

Example Response

Status code: 200

OK

{}

Status code: 400

Bad Request

{
  "error_code" : "DRS.10000010",
  "error_msg" : "Job does not exist, please check job ID."
}

Status Code

Status Code

Description

200

OK

400

Bad Request

Error Code

For details, see Error Code.

Parent topic: Task Management