调用CreateDISyncTask创建数据集成同步任务。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
dataworks:* | get | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ProjectId | long | 是 | DataWorks 工作空间的 ID。您可以登录 DataWorks 控制台,进入工作空间配置页面获取工作空间 ID。 | 10000 |
TaskType | string | 是 | 创建的数据集成同步任务的任务类型。 目前支持使用 CreateDISyncTask 接口创建数据集成离线同步任务(DI_OFFLINE),实时同步任务(DI_REALTIME)和解决方案(DI_SOLUTION)。 | DI_OFFLINE |
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"}]}} |
TaskParam | string | 是 | 数据集成同步任务的配置参数。目前支持配置如下参数:
| {"FileFolderPath":"业务流程/XXX/数据集成","ResourceGroup":"Serverless_res_group_XXX_XXXX", "Cu":1.5} |
TaskName | string | 是 | 创建的数据集成同步任务的名称。 | new_di_task |
ClientToken | string | 否 | 幂等参数,该参数可为空。 | 0000-ABCD-EFG**** |
返回参数
示例
正常返回示例
JSON
格式
{
"Success": true,
"RequestId": "0bc1411515937635973****",
"Data": {
"Status": "success",
"Message": "不合法的目录路径:业务流程/xxxx/数据集成",
"FileId": 1000001
}
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
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. | 数据集成内部业务错误 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-09-23 | OpenAPI 错误码发生变更 | 查看变更详情 |