Stops a real-time synchronization task.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| ProjectId |
integer |
Yes |
The DataWorks workspace ID. You can obtain the ID from the Workspace page in the DataWorks console. |
10000 |
| TaskType |
string |
Yes |
The type of the synchronization task to stop. Set the value to DI_REALTIME, which indicates a real-time synchronization task. |
DI_REALTIME |
| FileId |
integer |
Yes |
The synchronization task ID. You can call the ListFiles operation to query the ID. |
100 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response parameters. |
||
| Success |
boolean |
Whether the request was successful. Valid values:
|
true |
| RequestId |
string |
The request ID. You can use it to locate logs and troubleshoot issues. |
0bc1411515937635973**** |
| Data |
object |
The information about the synchronization task. |
|
| Status |
string |
Whether the synchronization task is stopped. Valid values:
|
success |
| Message |
string |
The reason why the synchronization task failed to stop. If the task stopped successfully, null is returned. |
fileId:[100] is invalid. |
Examples
Success response
JSON format
{
"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. | Param invalid |
| 500 | InternalError.System | An internal error occurred. | InternalError |
| 403 | Forbidden.Access | Access is forbidden. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.