全部产品
Search
文档中心

大数据开发治理平台 DataWorks:GenerateDISyncTaskConfigForUpdating - 异步生成更新同步任务配置

更新时间:Jul 09, 2024

异步生成更新同步任务的JSON。

接口说明

DataWorks 目前仅支持直接使用 UpdateDISyncTask 接口更新数据集成离线同步任务,而数据集成实时同步任务则需要先调用 GenerateDISyncTaskConfigForUpdating 和 QueryDISyncTaskConfigProcessResult 接口,异步生成更新数据集成同步任务需要的参数,再将该参数作为 UpdateDISyncTask 接口的入参,使用 UpdateDISyncTask 接口更新相应的实时同步任务。 仅支持使用异步方式更新数据集成实时同步任务。

调试

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

授权信息

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

请求参数

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

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

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

10000
TaskTypestring

使用异步方式更新数据集成同步任务的任务类型。取值如下:

  • DI_REALTIME:表示实时同步任务。
  • DI_SOLUTION:表示解决方案同步任务。 仅支持使用异步方式更新数据集成实时同步任务和解决方案同步任务。
DI_REALTIME
TaskParamstring

更新同步任务的脚本语句。 目前仅支持通过异步方式为数据集成同步任务新增表或者删除表,并且仅支持更新如下类型的同步任务:

  • 同步 MySQL 数据至 MaxCompute。
  • 同步 MySQL 数据至 Kafka。
  • 同步 MySQL 数据至 Hologres。

同步任务中的 SelectedTables 用于多库模式选择同步表,Tables 用于单库模式选择同步表。

  • 当脚本中包含 SelectedTables 语句时,系统会使用 SelectedTables 语句中的表信息进行同步。
  • 当脚本中包含 Tables 语句时,系统会使用 Tables 的字段信息进行同步。
{"steps":[{"parameter":{"connection":[{"table":["xyx"]}]},"name":"Reader","category":"reader"}]}
ClientTokenstring

幂等参数。用于避免多次调用导致操作重复。

ABFUOEUOTRTRJKE
TaskIdlong

任务 ID。

  • 当 TaskType 参数配置为实时同步任务(DI_REALTIME),则 TaskId 为实时同步任务的 FileId。
  • 当 TaskType 参数配置为解决方案同步任务(DI_SOLUTION),则 TaskId 为解决方案同步任务的 FileId。
100

返回参数

名称类型描述示例值
object

返回结果。

Successboolean

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

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

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

0bc1411515937635973****
Dataobject

异步线程 ID 的生成结果。

Statusstring

生成异步线程 ID 的结果状态。取值如下:

  • success:表示成功生成异步线程 ID。
  • fail:表示异步线程 ID 生成失败。您可以查看失败原因,处理相关问题。
true
ProcessIdlong

异步线程 ID。您需要通过该 ID,调用 QueryDISyncTaskConfigProcessResult 接口获取异步生成更新数据集成同步任务需要的参数,后续使用该参数更新数据集成同步任务。

10
Messagestring

异步线程 ID 生成失败的原因描述。 如果成功生成异步线程 ID,则该参数的返回值为空。

XXX is invalid.

示例

正常返回示例

JSON格式

{
  "Success": true,
  "RequestId": "0bc1411515937635973****",
  "Data": {
    "Status": "true",
    "ProcessId": 10,
    "Message": "XXX is invalid."
  }
}

错误码

HTTP status code错误码错误信息描述
400Invalid.DI.ParameterThe parameter is invalid.参数错误
400Invalid.DI.Parameter.File.ExistedThe file name already exists.参数不合法,文件名已存在
403Forbidden.DI.NoPrivilegeNo access.没有权限访问
500InternalError.DI.ParameterA DI internal error occurred.数据集成内部业务错误

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