TerminateDISyncInstance
Undeploys a real-time synchronization task.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| ProjectId |
integer |
Yes |
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. You must configure this parameter to specify the DataWorks workspace to which the API operation is applied. |
10000 |
| TaskType |
string |
Yes |
The value DI_REALTIME indicates that the task is a real-time synchronization task. |
DI_REALTIME |
| FileId |
integer |
Yes |
The file ID of the real-time synchronization task. |
100 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response parameters. |
||
| Success |
boolean |
Indicates whether the request was successful. Valid values:
|
true |
| RequestId |
string |
The request ID. You can locate logs and troubleshoot issues based on the ID. |
0bc1411515937635973**** |
| Data |
object |
The returned results. |
|
| Status |
string |
Indicates whether the real-time synchronization task is undeployed. Valid values:
|
success |
| Message |
string |
The reason why the real-time synchronization task fails to be terminated. If the real-time synchronization task is undeployed, the value of this parameter is null. |
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.