UpdateDISyncTask - 更新同步任务 - 大数据开发治理平台 DataWorks

更新数据集成同步任务。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
ProjectId	long	是	DataWorks 工作空间的 ID。您可以登录 DataWorks 控制台，进入工作空间配置页面获取工作空间 ID。该参数用来确定本次 API 调用操作使用的 DataWorks 工作空间。	10000
TaskType	string	是	修改的数据集成同步任务的任务类型。目前仅支持使用 UpdateDISyncTask 接口修改数据集成离线同步任务（DI_OFFLINE）。	DI_OFFLINE
TaskContent	string	是	更新已创建的数据集成同步任务通过脚本模式配置的任务内容。详情请参见通过脚本模式配置任务。当前仅支持通过 UpdateDISyncTask 接口更新数据集成离线同步任务。如果您无需更新数据集成同步任务的配置内容，则可将该参数置为空。	{"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_source","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	是	更新数据集成同步任务的配置参数，使用 JSON 格式。 ResourceGroup：表示数据集成同步任务所使用的数据集成资源组标识（Identifier）。您可以调用 ListResourceGroups ，获取资源组标识。 Cu：表示数据集成同步任务在 Serverless 资源组上占用的规格，必须是 0.5 的倍数。	{"ResourceGroup":"Serverless_res_group_XXX_XXXX", "Cu":1.5}
FileId	long	是	需要更新的数据集成同步任务的任务 ID。您可以调用 ListFiles 接口获取同步任务的 ID。	1000000

返回参数

名称	类型	描述	示例值
	object	返回数据。
Success	boolean	请求是否成功。取值如下： true：成功。 false：失败。	true
RequestId	string	请求 ID。用于定位日志，排查问题。	0bc1411515937635973****
Data	object	更新数据集成同步任务的返回结果。
Status	string	更新数据集成同步任务的结果状态。取值如下： success：表示更新数据集成同步任务成功。 fail：表示更新数据集成同步任务失败。	success
Message	string	更新数据集成同步任务失败后的原因描述。如果更新数据集成同步任务成功，则该参数的返回值为空。	ResourceGroup:[S_res_group_XXX] is invalid.

示例

正常返回示例

JSON格式

{
  "Success": true,
  "RequestId": "0bc1411515937635973****",
  "Data": {
    "Status": "success",
    "Message": "ResourceGroup:[S_res_group_XXX] is invalid."
  }
}

错误码

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

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