Stops a real-time synchronization node.

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 ID of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace Management page to obtain the workspace ID.

This parameter specifies the DataWorks workspace to which the operation is applied.

TaskType String Yes DI_REALTIME

The type of the synchronization node that you want to stop. Set the value to DI_REALTIME.

DI_REALTIME indicates a real-time synchronization node.

RegionId String Yes cn-zhangjiakou

The region ID. For example, the ID of the China (Shanghai) region is cn-shanghai, and that of the China (Zhangjiakou) region is cn-zhangjiakou. The system determines the value of this parameter based on the endpoint that is used to call the operation.

FileId Long Yes 100

The ID of the synchronization node. You can call the ListFiles operation to obtain the ID.

Response parameters

Parameter Type Example Description
Success Boolean true

Indicates whether the request is successful. Valid values:

  • true: The request is successful.
  • false: The request fails.
RequestId String 0bc1411515937635973****

The ID of the request. You can locate logs and troubleshoot issues based on the ID.

Data Object

The information returned for the synchronization node.

Status String success

Indicates whether the synchronization node is stopped. Valid values:

  • success: The synchronization node is stopped.
  • fail: The synchronization node fails to be stopped.
Message String fileId:[100] is invalid.

The reason why the synchronization node fails to be stopped.

If the synchronization node is stopped, the value null is returned.

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. The error message returned because one or more parameters are invalid.
500 InternalError.System An internal error occurred. The error message returned because an internal error has occurred.
403 Forbidden.Access Access is forbidden. The error message returned because you are not authorized to perform this operation.

For a list of error codes, visit the API Error Center.