调用UpdateDIProjectConfig修改当前工作空间中数据集成同步解决方案任务默认的全局配置。

当前DataWorks仅支持为同步解决方案任务中的实时同步DDL消息处理策略设置默认的全局配置。如果您的同步解决方案任务包含实时同步任务,则配置DDL消息处理规则时会读取此处的全局配置为默认配置。您也可以根据实际业务需求修改目标同步任务的默认DDL消息处理规则为所需的配置。配置数据集成同步解决方案任务,详情请参见配置同步解决方案任务

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String UpdateDIProjectConfig

要执行的操作。

DestinationType String odps

数据集成同步解决方案任务的目的端数据源。该参数不能为空。

调用UpdateDIProjectConfig修改同步解决方案的全局配置目前仅支持配置目的端数据源为analyticdb_for_mysql、odps、elasticsearch、holo、mysql及polardb。

ProjectConfig String {"RENAMECOLUMN":"WARNING","DROPTABLE":"WARNING","CREATETABLE":"WARNING","MODIFYCOLUMN":"WARNING","TRUNCATETABLE":"WARNING","DROPCOLUMN":"WARNING","ADDCOLUMN":"WARNING","RENAMETABLE":"WARNING"}

修改后的数据集成同步解决方案任务默认的全局配置内容(即对不同DDL消息类型配置的默认处理策略)。请使用JSON格式。示例如下:

{"RENAMECOLUMN":"WARNING","DROPTABLE":"WARNING","CREATETABLE":"WARNING","MODIFYCOLUMN":"WARNING","TRUNCATETABLE":"WARNING","DROPCOLUMN":"WARNING","ADDCOLUMN":"WARNING","RENAMETABLE":"WARNING"}

DDL消息类型如下:

  • RENAMECOLUMN:重命名列。
  • DROPTABLE:删除表。
  • CREATETABLE:新建表。
  • MODIFYCOLUMN:修改列类型。
  • TRUNCATETABLE:清空表。
  • DROPCOLUMN:删除列。
  • ADDCOLUMN:新增列。
  • RENAMETABLE:重命名表。

DataWorks收到对应类型的DDL消息时,处理策略如下:

  • WARNING:直接丢弃该消息,同时会在实时同步日志中记录告警信息,指明该消息因执行出错被丢弃。
  • IGNORE:直接丢弃该消息,不再向目的端数据源发送。
  • CRITICAL:实时同步任务直接显示出错状态并终止运行。
  • NORMAL:将相应消息继续下发给目的端数据源,由目的端数据源来处理。因为不同目的端数据源对DDL消息处理策略可能会不同,因此DataWorks只执行转发操作。
ProjectId Long 10000

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

RegionId String cn-shanghai

数据集成同步解决方案任务所在的地域。例如,华东2(上海)是cn-shanghai,华北3(张家口)是cn-zhangjiakou。您无需填写RegionId,会根据调用的endpoint自动解析。

SourceType String mysql

数据集成同步解决方案任务的源端数据源。

调用UpdateDIProjectConfig修改同步解决方案任务的全局配置目前仅支持配置源端数据源为oracle、mysql、polardb、datahub、drds及analyticdb_for_mysql。

如果不配置源端数据源,则默认全局配置对所有的源端数据源均生效。

返回数据

名称 类型 示例值 描述
Data Struct

修改目标工作空间中数据集成同步解决方案任务默认全局配置的返回结果。

Status String success

修改数据集成同步解决方案任务默认的全局配置是否成功。取值如下:

  • success:修改成功。
  • fail:修改失败。
RequestId String 0000-ABCD-EFG

本次调用的唯一ID。用于出现错误后定位日志,排查问题。

Success Boolean true

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

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

示例

请求示例

http(s)://[Endpoint]/?Action=UpdateDIProjectConfig
&DestinationType=odps
&ProjectConfig={"RENAMECOLUMN":"WARNING","DROPTABLE":"WARNING","CREATETABLE":"WARNING","MODIFYCOLUMN":"WARNING","TRUNCATETABLE":"WARNING","DROPCOLUMN":"WARNING","ADDCOLUMN":"WARNING","RENAMETABLE":"WARNING"}
&ProjectId=10000
&RegionId=cn-shanghai
&<公共请求参数>

正常返回示例

XML格式

<RequestId>0000-ABCD-EFG	</RequestId>
<Data>
    <Status>success</Status>
</Data>
<Success>true</Success>

JSON格式

{
    "RequestId": "0000-ABCD-EFG",
    "Data": {
        "Status": "success"
    },
    "Success": true
}

错误码

HttpCode 错误码 错误信息 描述
403 Forbidden.DI.NoPrivilege No access. 没有权限访问
500 InternalError.DI.Parameter A DI internal error occurred. 数据集成内部业务错误
400 Invalid.DI.Parameter The parameter is invalid. 参数错误

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