全部产品
Search
文档中心

大数据开发治理平台 DataWorks:StopDISyncInstance - 停止实时同步任务

更新时间:Nov 15, 2024

调用StopDISyncInstance接口,停止实时同步任务。

调试

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

授权信息

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

请求参数

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

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

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

10000
TaskTypestring

停止数据集成同步任务的任务类型。目前仅支持使用 DI_REALTIME 类型。

DI_REALTIME 代表实时任务。

DI_REALTIME
FileIdlong

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

100

返回参数

名称类型描述示例值
object

返回对象。

Successboolean

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

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

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

0bc1411515937635973****
Dataobject

停止同步任务的结果。

Statusstring

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

  • success:表示停止数据集成同步任务成功。
  • fail:表示停止数据集成同步任务失败。
success
Messagestring

停止数据集成同步任务失败后的原因描述。

如果停止数据集成同步任务成功,则该参数的返回值为空。

fileId:[100] is invalid.

示例

正常返回示例

JSON格式

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

错误码

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

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