StopDISyncInstance - DataWorks - Alibaba Cloud Documentation Center

Stops a real-time synchronization task.

Debugging

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 API operation is applied.	10000
TaskType	string	Yes	The type of the synchronization task that you want to stop. Set the value to DI_REALTIME. DI_REALTIME indicates a real-time synchronization task.	DI_REALTIME
FileId	long	Yes	The ID of the synchronization task. You can call the ListFiles operation to query the ID.	100

Parameter	Type	Description	Example
	object	The response parameters.
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 information returned for the synchronization task.
Status	string	Indicates whether the synchronization task is stopped. Valid values: success fail	success
Message	string	The reason why the synchronization task fails to be stopped. If the synchronization task is stopped, the value null is returned.	fileId:[100] is invalid.

Sample success responses

JSONformat

{
  "Success": true,
  "RequestId": "0bc1411515937635973****",
  "Data": {
    "Status": "success",
    "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.