Undeploys 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. Log on to the DataWorks console and go to the Workspace page to obtain the ID. Configure this parameter to specify the DataWorks workspace to which the API operation applies. |
10000 |
| TaskType |
string |
Yes |
The task type. The value DI_REALTIME specifies a real-time synchronization task. |
DI_REALTIME |
| FileId |
integer |
Yes |
The ID of the real-time synchronization task. |
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. Used to locate logs and troubleshoot issues. |
0bc1411515937635973**** |
| Data |
object |
The returned results. |
|
| Status |
string |
Whether the task was undeployed. Valid values:
|
success |
| Message |
string |
The failure reason. Null if the task is successfully undeployed. |
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.