更新数据集成任务。
接口说明
需要购买 DataWorks 基础版及以上版本才能使用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Id | long | 否 | 任务 ID。 | 11588 |
Description | string | 否 | 任务的描述 | DI Job Demo |
TableMappings | array<object> | 否 | 同步对象转换映射列表,列表中每个元素描述了一组源端同步对象选择规则列表和在该组同步对象上应用的同步对象转换规则列表 说明
[ { "SourceObjectSelectionRules":[ { "ObjectType":"Database", "Action":"Include", "ExpressionType":"Exact", "Expression":"biz_db" }, { "ObjectType":"Schema", "Action":"Include", "ExpressionType":"Exact", "Expression":"s1" }, { "ObjectType":"Table", "Action":"Include", "ExpressionType":"Exact", "Expression":"table1" } ], "TransformationRuleNames":[ { "RuleName":"my_database_rename_rule", "RuleActionType":"Rename", "RuleTargetType":"Schema" } ] } ]
| |
object | 否 | 同步对象转换映射列表,列表中每个元素描述了一组源端同步对象选择规则列表和在该组同步对象上应用的同步对象转换规则列表 | ||
SourceObjectSelectionRules | array<object> | 否 | 每条规则可选择待同步源端对象的不同对象类型,如选择源端数据库、源端数据表 | |
object | 否 | 每条规则可选择待同步源端对象的不同对象类型,如选择源端数据库、源端数据表 | ||
Action | string | 否 | 选择动作,取值范围:Include/Exclude | Include |
Expression | string | 否 | 表达式 | mysql_table_1 |
ExpressionType | string | 否 | 表达式类型,取值范围:Exact/Regex | Exact |
ObjectType | string | 否 | 对象类型,可选的枚举值:
| Table |
TransformationRules | array<object> | 否 | 源端对象上应用的转换规则 | |
object | 否 | 源端对象上应用的转换规则 | ||
RuleName | string | 否 | 规则名称,在一种动作类型+动作作用的目标类型下规则名称唯一,长度不能超过 50 个字符 | rename_rule_1 |
RuleActionType | string | 否 | 动作类型,可选的枚举值:
| Rename |
RuleTargetType | string | 否 | 动作作用的目标类型,可选的枚举值:
| Table |
JobSettings | object | 否 | 同步任务维度的设置,含 DDL 处理策略、源端和目标端列数据类型映射策略、任务运行时参数等 | |
ChannelSettings | string | 否 | 通道相关任务设置,可以对一些特定通道进行特殊配置,目前支持 Holo2Holo(从 holo 同步到 holo),Holo2Kafka(从 Holo 同步到 Kafka)
| { "structInfo": "MANAGED", "storageType": "TEXTFILE", "writeMode": "APPEND", "partitionColumns": [ { "columnName": "pt", "columnType": "STRING", "comment": "" } ], "fieldDelimiter": "" } |
ColumnDataTypeSettings | array<object> | 否 | 列类型映射数组 说明
["ColumnDataTypeSettings":[ { "SourceDataType":"Bigint", "DestinationDataType":"Text" } ]
| |
object | 否 | 单条列类型映射 | ||
DestinationDataType | string | 否 | 目标端类型。如 bigint,boolean,string,text,datetime,timestamp,decimal,binary,不同数据源类型会有类型差异 | text |
SourceDataType | string | 否 | 源端类型。如 bigint,boolean,string,text,datetime,timestamp,decimal,binary,不同数据源类型会有类型差异 | bigint |
CycleScheduleSettings | object | 否 | 周期调度设置 | |
ScheduleParameters | string | 否 | 调度参数 | bizdate=$bizdate |
DdlHandlingSettings | array<object> | 否 | DDL 处理设置数组。 说明
["DDLHandlingSettings":[ { "Type":"Insert", "Action":"Normal" } ]
| |
object | 否 | 单条 DDL 处理设置 | ||
Action | string | 否 | 处理动作,可选的枚举值:
| Critical |
Type | string | 否 | DDL 类型,可选的枚举值:
| AddColumn |
RuntimeSettings | array<object> | 否 | 运行时设置 | |
object | 否 | 运行时设置 | ||
Name | string | 否 | 设置名称,可选的枚举值:
| src.offline.datasource.max.connection |
Value | string | 否 | 设置取值 | 1 |
ResourceSettings | object | 否 | 资源设置 | |
OfflineResourceSettings | object | 否 | 离线同步资源 | |
RequestedCu | double | 否 | 离线同步使用的数据集成资源组 cu | 2 |
ResourceGroupIdentifier | string | 否 | 离线同步使用的数据集成资源组名称 | S_res_group_111_222 |
RealtimeResourceSettings | object | 否 | 实时同步资源 | |
RequestedCu | double | 否 | 实时同步使用的数据集成资源组 cu | 2 |
ResourceGroupIdentifier | string | 否 | 实时同步使用的数据集成资源组名称 | S_res_group_111_222 |
ScheduleResourceSettings | object | 否 | 调度资源 | |
RequestedCu | double | 否 | 离线同步任务使用的调度资源组 cu | 2 |
ResourceGroupIdentifier | string | 否 | 离线同步任务使用的调度资源组名称 | S_res_group_222_333 |
TransformationRules | array<object> | 否 | 同步对象转换规则定义列表 说明
[ { "RuleName":"my_database_rename_rule", "RuleActionType":"Rename", "RuleTargetType":"Schema", "RuleExpression":"{"expression":"${srcDatasoureName}_${srcDatabaseName}"}" } ]
| |
object | 否 | 单个同步对象转换规则定义,每个元素为一条转换规则定义 | ||
RuleActionType | string | 否 | 动作类型,可选的枚举值:
| Rename |
RuleExpression | string | 否 | 规则表达式,json string 格式。
| {"expression":"${srcDatasoureName}_${srcDatabaseName}"} |
RuleName | string | 否 | 规则名称,当动作类型和动作作用的目标类型相同时,规则名称需保证唯一性,长度不能超过 50 个字符 | rename_rule_1 |
RuleTargetType | string | 否 | 动作作用的目标类型,可选的枚举值:
| Table |
ProjectId | long | 否 | DataWorks 工作空间 ID。您可以通过 ListProjects 接口获取工作空间 ID。 | 10000 |
DIJobIddeprecated | long | 否 | 该字段已废弃,请使用 Id 字段。 | 11588 |
Owner | string | 否 | 任务责任人 | 95279527 |
返回参数
示例
正常返回示例
JSON
格式
{
"Success": true,
"RequestId": "AAC30B35-820D-5F3E-A42C-E96BB****"
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2025-01-06 | OpenAPI 入参发生变更 | 查看变更详情 |
2024-12-11 | API 内部配置变更,不影响调用 | 查看变更详情 |
2024-10-14 | OpenAPI 入参发生变更 | 查看变更详情 |