CreateDIJob - 创建数据集成同步任务

创建数据集成新版任务。

接口说明

  • 需要购买 DataWorks 基础版及以上版本才能使用。
  • 该接口创建了数据集成同步任务, 参数包括同步任务的源端配置 SourceDataSourceSettings 和目的端配置 DestinationDataSourceSettings,以及支持的同步类型 MigrationType,同时通过 TransformationRules 定义了对同步表做的如加列,表名替换等映射 rule,在 TableMappings 中定义了要同步的具体表以及表需要使用的映射 rule,在 JobSettings 中定义了任务的列映射和周期设置等。

调试

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

授权信息

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

请求参数

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

目标端数据源类型,枚举值:Hologres,OSS-HDFS,OSS,MaxCompute,LogHub,StarRocks,DataHub,AnalyticDB_For_MySQL,Kafka,Hive。

Hologres
SourceDataSourceTypestring

源端数据源类型,枚举值: PolarDB,MySQL,Kafka,LogHub,Hologres,Oracle,OceanBase,MongoDB,RedShift,Hive,SQLServer,Doris,ClickHouse。

MySQL
ProjectIdlong

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

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

10000
Namestring

任务名称。

mysql_to_holo_sync_8772
MigrationTypestring

同步类型,可选的枚举值有:

  • FullAndRealtimeIncremental(全量和实时增量,整库实时)
  • RealtimeIncremental(实时增量,单表实时)
  • Full(全量,整库离线)
  • OfflineIncremental(离线增量,整库离线)
  • FullAndOfflineIncremental(全量+离线增量,整库离线)
FullAndRealtimeIncremental
JobTypestring

任务类型,可选

  • DatabaseRealtimeMigration(整库实时):将源端多个库的多个表进行流同步,支持仅全量,仅增量,或全量+增量。

  • DatabaseOfflineMigration(整库离线):将源端多个库的多个表进行批同步,支持仅全量,仅增量,或全量+增量。

  • SingleTableRealtimeMigration(单表实时):将源端单个表进行流同步

DatabaseRealtimeMigration
JobNamedeprecatedstring

该字段已废弃,请使用 Name 字段。

mysql_to_holo_sync_8772

返回参数

名称类型描述示例值
object

Schema of Response

Idlong

数据集成任务 ID。

11792
RequestIdstring

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

4F6AB6B3-41FB-5EBB-AFB2-0C98D49DA2BB
DIJobIddeprecatedlong

该字段已废弃,请使用 Id 字段。

11792

示例

正常返回示例

JSON格式

{
  "Id": 11792,
  "RequestId": "4F6AB6B3-41FB-5EBB-AFB2-0C98D49DA2BB",
  "DIJobId": 11792
}

错误码

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

变更历史

变更时间变更内容概要操作
2025-03-27OpenAPI 入参发生变更查看变更详情
2025-01-06OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情