DeleteDISyncTask

更新时间:
复制 MD 格式

Deletes a real-time synchronization task.

Operation description

To delete a batch synchronization task, call the DeleteFile operation. For more information, see Delete a synchronization task.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

ProjectId

integer

Yes

The DataWorks workspace ID. You can obtain the ID from the Workspace page in the DataWorks console.

This parameter specifies the workspace to which the operation applies.

10000

TaskType

string

Yes

The task type. Set the value to DI_REALTIME, which indicates a real-time synchronization task.

DI_REALTIME

FileId

integer

Yes

The ID of the real-time synchronization task. Call the ListFiles operation to query the ID.

100

Response elements

Element

Type

Description

Example

object

The returned result.

Success

boolean

Indicates whether the request was successful. Valid values:

  • true

  • false

true

RequestId

string

The request ID. Use this ID to locate logs and troubleshoot issues.

0bc1411515937635973****

Data

object

The deletion result.

Status

string

Indicates whether the synchronization task is deleted. Valid values:

  • success: The synchronization task is deleted.

  • fail: The synchronization task fails to be deleted. You can troubleshoot the issue based on the failure reason.

fail

Message

string

The failure reason. If the task is deleted successfully, null is returned.

fileId:[100] is invalid.

Examples

Success response

JSON format

{
  "Success": true,
  "RequestId": "0bc1411515937635973****",
  "Data": {
    "Status": "fail",
    "Message": "fileId:[100] is invalid."
  }
}

Error codes

HTTP status code

Error code

Error message

Description

400 Param.Invalid The parameter is invalid. Param invalid
500 InternalError.System An internal error occurred. InternalError
403 Forbidden.Access Access is forbidden.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.