文档

CreateDISyncTask - 创建数据集成同步任务

更新时间:

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

调试

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

授权信息

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

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

请求参数

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

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

10000
TaskTypestring

创建的数据集成同步任务的任务类型。 目前支持使用 CreateDISyncTask 接口创建数据集成离线同步任务(DI_OFFLINE),实时同步任务(DI_REALTIME)和解决方案(DI_SOLUTION)。

DI_OFFLINE
TaskParamstring

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

  • FileFolderPath:表示数据集成同步任务的存放路径。
  • ResourceGroup:表示数据集成同步任务所使用的数据集成资源组标识(Identifier)。您可以调用 ListResourceGroups ,获取资源组标识。
{"FileFolderPath":"业务流程/XXX/数据集成","ResourceGroup":"S_res_group_XXX_XXXX"}
TaskNamestring

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

new_di_task
ClientTokenstring

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

0000-ABCD-EFG****

返回参数

名称类型描述示例值
object
Successboolean

请求是否成功。

true
RequestIdstring

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

0bc1411515937635973****
Dataobject

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

Statusstring

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

  • success:表示创建任务成功。
  • fail:表示创建任务失败。
success
Messagestring

创建数据集成同步任务失败的原因描述,如果成功,该字段为空,如果不成功,实例如下"不合法的目录路径:业务流程/xxxx/数据集成",

不合法的目录路径:业务流程/xxxx/数据集成
FileIdlong

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

1000001

示例

正常返回示例

JSON格式

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

错误码

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

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

变更历史

变更时间变更内容概要操作
2024-09-23OpenAPI 错误码发生变更查看变更详情