DeleteDISyncTask - DataWorks - Alibaba Cloud Documentation Center

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

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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	DeleteDISyncTask	The operation that you want to perform. Set the value to DeleteDISyncTask.
ProjectId	Long	Yes	10000	The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to obtain the ID. You must configure this parameter to specify the DataWorks workspace to which the synchronization task belongs.
TaskType	String	Yes	DI_REALTIME	The type of the synchronization task in Data Integration. You can set this parameter only to DI_REALTIME, which indicates a real-time synchronization task.
FileId	Long	Yes	100	The ID of the real-time synchronization task. You can call the ListFiles operation to query the ID.

Response parameters


Parameter	Type	Example	Description
Success	Boolean	true	Indicates whether the request was successful. Valid values: true false
RequestId	String	0bc1411515937635973****	The request ID. You can locate logs and troubleshoot issues based on the ID.
Data	Object		The deletion result.
Status	String	fail	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.
Message	String	fileId:[100] is invalid.	The reason why the synchronization task fails to be deleted. If the synchronization task is deleted, the value of this parameter is null.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DeleteDISyncTask
&ProjectId=10000
&TaskType=DI_REALTIME
&FileId=100
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DeleteDISyncTaskResponse>
    <Success>true</Success>
    <RequestId>0bc1411515937635973****</RequestId>
    <Data>
        <Status>fail</Status>
        <Message>fileId:[100] is invalid.</Message>
    </Data>
</DeleteDISyncTaskResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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.	One or more parameters are invalid.
500	InternalError.System	An internal error occurred.	An internal error has occurred.

For a list of error codes, see Service error codes.