DeleteDISyncTask - DataWorks - Alibaba Cloud Documentation Center

Deletes a synchronization task. You can call this operation to delete only a real-time synchronization task.

Operation description

If you want to delete a batch synchronization task, call the DeleteFile operation. For more information, see Delete a synchronization task.

There is currently no authorization information disclosed in the API.

Parameter	Type	Required	Description	Example
ProjectId	long	Yes	The ID of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace page to obtain the workspace ID. You must configure this parameter to specify the DataWorks workspace to which the operation is applied.	10000
TaskType	string	Yes	The type of the task. Set the value to DI_REALTIME, which indicates a real-time synchronization task.	DI_REALTIME
FileId	long	Yes	The ID of the real-time synchronization task. You can call the ListFiles operation to query the ID.	100

Parameter	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. You can locate logs and troubleshoot issues based on the ID.	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 reason why the synchronization task fails to be deleted. If the synchronization task is deleted, the value null is returned for this parameter.	fileId:[100] is invalid.

Sample success responses

JSONformat

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

HTTP status code	Error code	Error message	Description
400	Param.Invalid	The parameter is invalid.	Param invalid
403	Forbidden.Access	Access is forbidden.	-
500	InternalError.System	An internal error occurred.	InternalError

For a list of error codes, visit the Service error codes.