全部产品
Search

搜索本产品

    大数据开发治理平台 DataWorks：ListDIProjectConfig - 查看数据集成项目默认配置

    文档中心

    大数据开发治理平台 DataWorks：ListDIProjectConfig - 查看数据集成项目默认配置

    更新时间：Nov 21, 2024

    查看当前工作空间中数据集成同步解决方案任务默认的全局配置。

    接口说明

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

    调试

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

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    dataworks:*get
    *全部资源
    *
      无
    		无

    请求参数

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

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

    		1000
    DestinationTypestring是

    数据集成同步解决方案任务的目的端数据源。该参数不能为空。 调用 ListDIProjectConfig 查看同步解决方案的全局配置目前仅支持配置目的端数据源为 analyticdb_for_mysql、odps、elasticsearch、holo、mysql 及 polardb。

    		elasticsearch
    SourceTypestring否

    数据集成同步解决方案任务的源端数据源。 调用 ListDIProjectConfig 查看同步解决方案的全局配置目前仅支持配置源端数据源为 oracle、mysql、polardb、datahub、drds 及 analyticdb_for_mysql。 如果不配置源端数据源，则默认全局配置对所有的源端数据源均生效。

    		mysql

    返回参数

    名称类型描述示例值
    object
    Successboolean

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

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

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

    		0000-ABCD-EFG
    Dataobject

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

    Configstring

    数据集成同步解决方案任务默认的全局配置内容（即对不同 DDL 消息类型配置的默认处理策略）。示例如下： {"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 只执行转发操作。
    		{"RENAMECOLUMN":"WARNING","DROPTABLE":"WARNING","CREATETABLE":"WARNING","MODIFYCOLUMN":"WARNING","TRUNCATETABLE":"WARNING","DROPCOLUMN":"WARNING","ADDCOLUMN":"WARNING","RENAMETABLE":"WARNING"}

    示例

    正常返回示例

    JSON格式

    {
  "Success": true,
  "RequestId": "0000-ABCD-EFG\t",
  "Data": {
    "Config": "{\"RENAMECOLUMN\":\"WARNING\",\"DROPTABLE\":\"WARNING\",\"CREATETABLE\":\"WARNING\",\"MODIFYCOLUMN\":\"WARNING\",\"TRUNCATETABLE\":\"WARNING\",\"DROPCOLUMN\":\"WARNING\",\"ADDCOLUMN\":\"WARNING\",\"RENAMETABLE\":\"WARNING\"}"
  }
}

    错误码

    HTTP status code错误码错误信息描述
    400Invalid.DI.ParameterThe parameter is invalid.参数错误
    403Forbidden.DI.NoPrivilegeNo access.没有权限访问
    500InternalError.DI.ParameterA DI internal error occurred.数据集成内部业务错误

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