StopDISyncInstance -

Stops a real-time 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	StopDISyncInstance	The operation that you want to perform.
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 API operation is applied.
TaskType	String	Yes	DI_REALTIME	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.
FileId	Long	Yes	100	The synchronization task ID. You can call the ListFiles operation to obtain 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 returned result.
Status	String	success	Indicates whether the synchronization task is stopped. Valid values: success: The synchronization task is stopped. fail: The synchronization task fails to be stopped.
Message	String	fileId:[100] is invalid.	The reason why the synchronization task fails to be stopped. If the synchronization task is stopped, no value is returned for this parameter.

Examples

Sample requests

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

Sample success responses

XML format

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

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

JSON format

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

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