文档

DeleteDISyncTask - 删除数据集成同步任务

更新时间:

调用DeleteDISyncTask接口,删除数据集成同步任务。当前仅支持使用该接口删除实时数据同步任务。

接口说明

如果您希望删除离线数据同步任务,请使用 DeleteFile 接口,具体操作流程请参考删除同步任务

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
ProjectIdlong

DataWorks 工作空间的 ID。您可以登录 DataWorks 控制台,进入工作空间配置页面获取工作空间 ID。

该参数用于确定本次 API 调用操作使用的 DataWorks 工作空间。

10000
TaskTypestring

数据集成同步任务的类型。 当前仅支持取值为 DI_REALTIME,表示实时数据同步任务。

DI_REALTIME
FileIdlong

实时数据同步任务的 ID。您可以调用 ListFiles 接口获取任务 ID。

100

返回参数

名称类型描述示例值
object

返回结果。

Successboolean

请求是否成功。取值如下:

  • true:请求成功。
  • false:请求失败。
true
RequestIdstring

请求 ID。用于定位日志,排查问题。

0bc1411515937635973****
Dataobject

删除数据集成同步任务的结果。

Statusstring

删除数据集成同步任务的结果状态。取值如下:

  • success:表示删除数据集成同步任务成功。
  • fail:表示删除数据集成同步任务失败。您可以查看具体的失败原因处理问题。
fail
Messagestring

删除数据集成同步任务失败后的原因描述。 如果删除数据集成同步任务成功,则该参数的返回值为空。

fileId:[100] is invalid.

示例

正常返回示例

JSON格式

{
  "Success": true,
  "RequestId": "0bc1411515937635973****",
  "Data": {
    "Status": "fail",
    "Message": "fileId:[100] is invalid."
  }
}

错误码

HTTP status code错误码错误信息描述
400Param.InvalidThe parameter is invalid.参数错误
403Forbidden.AccessAccess is forbidden.-
500InternalError.SystemAn internal error occurred.内部报错

访问错误中心查看更多错误码。