调用UpdateDISyncTask更新数据集成同步任务。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
|
名称 |
类型 |
是否必选 |
示例值 |
描述 |
| Action | String | 是 | UpdateDISyncTask | 系统规定参数。取值：UpdateDISyncTask。 |
| ProjectId | Long | 是 | 10000 | DataWorks工作空间的ID。您可以登录DataWorks控制台，进入工作空间配置页面获取工作空间ID。 该参数用来确定本次API调用操作使用的DataWorks工作空间。 |
| TaskType | String | 是 | DI_OFFLINE | 修改的数据集成同步任务的任务类型。 目前仅支持使用UpdateDISyncTask接口修改数据集成离线同步任务（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_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"}]}} | 更新已创建的数据集成同步任务通过脚本模式配置的任务内容。详情请参见通过脚本模式配置任务。当前仅支持通过UpdateDISyncTask接口更新数据集成离线同步任务。如果您无需更新数据集成同步任务的配置内容，则可将该参数置为空。 |
| TaskParam | String | 否 | {"ResourceGroup":"S_res_group_XXX_XXXX"} | 更新数据集成同步任务的配置参数，使用JSON格式。 目前仅支持更新数据集成同步任务的配置参数ResourceGroup，即数据集成同步任务所使用的数据集成资源组标识（Identifier）。您可以调用ListResourceGroups，获取资源组标识。 如果您无需更新数据集成同步任务的配置参数，则可将TaskParam置为空。 |
| FileId | Long | 是 | 1000000 | 需要更新的数据集成同步任务的任务ID。您可以调用ListFiles接口获取同步任务的ID。 |
返回数据
名称 |
类型 |
示例值 |
描述 |
| Success | Boolean | true | 请求是否成功。取值如下：
|
| RequestId | String | 0bc1411515937635973**** | 请求ID。用于定位日志，排查问题。 |
| Data | Object | 更新数据集成同步任务的返回结果。 |
|
| Status | String | success | 更新数据集成同步任务的结果状态。取值如下：
|
| Message | String | ResourceGroup:[S_res_group_XXX] is invalid. | 更新数据集成同步任务失败后的原因描述。如果更新数据集成同步任务成功，则该参数的返回值为空。 |
示例
请求示例
http(s)://[Endpoint]/?Action=UpdateDISyncTask
&FileId=1000000
&ProjectId=10000
&RegionId=cn-zhangjiakou
&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_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={"ResourceGroup":"S_res_group_XXX_XXXX"}
&TaskType=DI_OFFLINE
&<公共请求参数>正常返回示例
XML格式
HTTP/1.1 200 OK
Content-Type:application/xml
<RequestId>0bc1411515937635973****</RequestId>
<Data>
<Status>success</Status>
<Message>ResourceGroup:[S_res_group_XXX] is invalid.</Message>
</Data>
<Success>true</Success>JSON格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "0bc1411515937635973****",
"Data" : {
"Status" : "success",
"Message" : "ResourceGroup:[S_res_group_XXX] is invalid."
},
"Success" : true
}错误码
|
HttpCode |
错误码 |
错误信息 |
描述 |
| 400 | Invalid.DI.Parameter | The parameter is invalid. | 参数错误 |
| 403 | Forbidden.DI.NoPrivilege | No access. | 没有权限访问 |
| 500 | InternalError.DI.Parameter | A DI internal error occurred. | 数据集成内部业务错误 |
访问错误中心查看更多错误码。