CreateDIJob_大数据开发治理平台 DataWorks_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

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

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
暂无数据

请求参数

字段名称字段详情
DestinationDataSourceTypestring

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

示例值:Hologres
Descriptionstring

任务的描述

示例值:任务描述
SourceDataSourceTypestring

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

示例值:MySQL
ProjectIdinteger<int64>

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

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:10000参考取值来源:
    CreateProject
Namestring

任务名称。

示例值:mysql_to_holo_sync_8772
MigrationTypestring

同步类型,可选的枚举值有:展开详情

示例值:FullAndRealtimeIncremental
JobTypestring

任务类型,可选展开详情

示例值:DatabaseRealtimeMigration参考取值来源:
    GetDIJob
SourceDataSourceSettingsarray<object>

源端数据源设置列表。

DestinationDataSourceSettingsarray<object>

目标端数据源设置列表。

ResourceSettingsobject

资源设置。

TransformationRulesarray<object>

同步对象转换规则定义列表。展开详情

TableMappingsarray<object>

同步对象转换映射列表,列表中每个元素描述了一组源端同步对象选择规则列表和在该组同步对象上应用的同步对象转换规则列表。展开详情

JobSettingsobject

同步任务维度的设置,含 DDL 处理策略、源端和目标端列数据类型映射策略、任务运行时参数等。

deprecatedJobNamestring

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

示例值:mysql_to_holo_sync_8772参考取值来源:
    GetDIJob

返回参数

字段名称字段详情
Idinteger<int64>

数据集成任务 ID。

注意 请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。
示例值:11792
RequestIdstring

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

示例值:4F6AB6B3-41FB-5EBB-AFB2-0C98D49DA2BB
deprecatedDIJobIdinteger<int64>

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

注意 请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。
示例值:11792

返回示例

变更历史

变更时间变更内容概要操作
2025-03-27
新增请求参数JobType
2025-01-06
变更请求参数JobName
新增请求参数Name
变更返回参数

相关示例