调用CreateDISyncTask创建数据集成同步任务。

DataWorks目前仅支持直接使用CreateDISyncTask接口创建数据集成离线同步任务,而数据集成实时同步任务和解决方案同步任务则需要先调用GenerateDISyncTaskConfigForCreatingQueryDISyncTaskConfigProcessResult接口,获取异步生成创建数据集成同步任务时需要的参数,再将该参数作为CreateDISyncTask接口的入参,使用CreateDISyncTask接口创建相应的实时同步任务和解决方案同步任务。

调试

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

请求参数

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

系统规定参数。取值:CreateDISyncTask

ProjectId Long 10000

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

TaskType String DI_OFFLINE

创建的数据集成同步任务的任务类型。

目前仅支持使用CreateDISyncTask接口创建数据集成离线同步任务(DI_OFFLINE)。

RegionId String cn-zhangjiakou

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

TaskContent String {"type":"job","version":"2.0","steps":[{"stepType":"mysql","parameter":{"envType":1,"datasource":"mysql_pub","column":["id","name","create_time","age","score","t_01"],"connection":[{"datasource":"mysql_pub","table":["u_pk"]}],"where":"","splitPk":"id","encoding":"UTF-8"},"name":"Reader","category":"reader"},{"stepType":"odps","parameter":{"partition":"pt=${bizdate}","truncate":true,"datasource":"odps_first","envType":1,"column":["id","name","create_time","age","score","t_01"],"emptyAsNull":false,"tableComment":"null","table":"u_pk"},"name":"Writer","category":"writer"}],"setting":{"executeMode":null,"errorLimit":{"record":""},"speed":{"concurrent":2,"throttle":false}},"order":{"hops":[{"from":"Reader","to":"Writer"}]}}

使用脚本模式配置数据集成离线同步任务的配置内容。详情请参见通过脚本模式配置任务

当前仅支持通过CreateDISyncTask接口创建数据集成离线同步任务。

TaskParam String {"FileFolderPath":"业务流程/XXX/数据集成","ResourceGroup":"S_res_group_XXX_XXXX"}

数据集成同步任务的配置参数。目前支持配置如下参数:

  • FileFolderPath:表示数据集成同步任务的存放路径。
  • ResourceGroup:表示数据集成同步任务所使用的数据集成资源组标识(Identifier)。您可以调用ListResourceGroups,获取资源组标识。
TaskName String new_di_task

创建的数据集成同步任务的名称。

ClientToken String 0000-ABCD-EFG****

幂等参数,该参数可为空。

返回数据

名称 类型 示例值 描述
Success Boolean true

请求是否成功。

RequestId String 0bc1411515937635973****

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

Data Object

创建数据集成同步任务的返回结果。

Status String success

创建数据集成同步任务的结果状态。取值如下:

  • success:表示创建任务成功。
  • fail:表示创建任务失败。
Message String 不合法的目录路径:业务流程/重兴xxxx/数据集成

创建数据集成同步任务失败的原因描述。

FileId Long 1000001

成功创建的数据集成同步任务的任务ID。

示例

请求示例

http(s)://[Endpoint]/?Action=CreateDISyncTask
&ProjectId=10000
&TaskType=DI_OFFLINE
&TaskContent={"type":"job","version":"2.0","steps":[{"stepType":"mysql","parameter":{"envType":1,"datasource":"mysql_pub","column":["id","name","create_time","age","score","t_01"],"connection":[{"datasource":"mysql_pub","table":["u_pk"]}],"where":"","splitPk":"id","encoding":"UTF-8"},"name":"Reader","category":"reader"},{"stepType":"odps","parameter":{"partition":"pt=${bizdate}","truncate":true,"datasource":"odps_first","envType":1,"column":["id","name","create_time","age","score","t_01"],"emptyAsNull":false,"tableComment":"null","table":"u_pk"},"name":"Writer","category":"writer"}],"setting":{"executeMode":null,"errorLimit":{"record":""},"speed":{"concurrent":2,"throttle":false}},"order":{"hops":[{"from":"Reader","to":"Writer"}]}}
&TaskParam={"FileFolderPath":"业务流程/XXX/数据集成","ResourceGroup":"S_res_group_XXX_XXXX"}
&TaskName=new_di_task
&ClientToken=0000-ABCD-EFG****
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateDISyncTaskResponse>
    <Success>true</Success>
    <RequestId>0bc1411515937635973****</RequestId>
    <Data>
        <Status>success</Status>
        <Message>不合法的目录路径:业务流程/重兴xxxx/数据集成</Message>
        <FileId>1000001</FileId>
    </Data>
</CreateDISyncTaskResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Success" : true,
  "RequestId" : "0bc1411515937635973****",
  "Data" : {
    "Status" : "success",
    "Message" : "不合法的目录路径:业务流程/重兴xxxx/数据集成",
    "FileId" : 1000001
  }
}

错误码

HttpCode 错误码 错误信息 描述
400 Invalid.DI.Parameter The parameter is invalid. 参数错误
400 Invalid.DI.Parameter.File.Existed The file name already exists. 参数不合法,文件名已存在
403 Forbidden.DI.NoPrivilege No access. 没有权限访问
500 InternalError.DI.Parameter A DI internal error occurred. 数据集成内部业务错误

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