全部产品
Search
文档中心

大数据开发治理平台 DataWorks:QueryDISyncTaskConfigProcessResult - 查询异步任务结果

更新时间:Jul 09, 2024

查询异步任务结果。

接口说明

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

调试

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

授权信息

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

请求参数

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

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

该参数用来确定本次 API 调用操作使用的 DataWorks 工作空间。

10000
TaskTypestring

异步方式创建或更新的同步任务的任务类型。取值如下:

  • DI_REALTIME:表示实时同步任务。
  • DI_SOLUTION:表示解决方案同步任务。 仅支持使用异步方式创建或更新数据集成实时同步任务和解决方案同步任务。
DI_REALTIME
AsyncProcessIdlong

异步线程的 ID。您可以调用 GenerateDISyncTaskConfigForCreatingGenerateDISyncTaskConfigForUpdating 接口获取 ID。

  • GenerateDISyncTaskConfigForCreating:表示创建数据集成同步任务。
  • GenerateDISyncTaskConfigForUpdating:表示更新数据集成同步任务。
10

返回参数

名称类型描述示例值
object

返回结果。

Successboolean

请求是否成功。取值如下:

  • true:成功。
  • false:失败。
true
RequestIdstring

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

0bc1411515937635973****
Dataobject

获取异步生成或更新数据集成同步任务所需参数的返回结果。

Statusstring

获取异步生成或更新数据集成同步任务所需参数的结果状态。取值如下:

  • success:表示成功获取相关参数。
  • fail:表示获取相关参数失败。您可以查看失败原因,处理相关问题。
success
Messagestring

获取异步生成或更新数据集成同步任务所需参数失败的原因描述。如果获取成功,则该参数的返回值为空。

fileId:[100] is invalid.
TaskContentstring

异步线程生成的数据集成同步任务所需参数。该参数将作为 CreateDISyncTaskUpdateDISyncTask 接口的输入参数,用于后续创建或更新数据集成同步任务。

{"extend":{"mode":"migration_holo","resourceGroup":"280749","name":"h"},"type":"job","steps":[{"stepType":"mysql","parameter":{"connection":[{"datasourceType":"mysql","datasource":"mm","selectedTables":[{"schema":[{"tableInfos":[{"enable":true,"table":"m_v1","tableName":"m_v1"}]}],"dbName":"m"}]}]},"name":"reader","category":"reader"},{"stepType":"holo","parameter":{"datasource":"h","tableMappingRule":{"datasource":[{"tableRule":[{"srcTable":"m_v1","mergeIntoCycleType":"DEFAULT","hourDeltaEnable":false,"dstTable":"m.m_v1","dayDeltaEnable":false,"primaryKeyInfo":{"column":["id"],"type":"pk"},"dstCreateTableInfo":{"indexType":"m_v1","dataColumn":[{"columnSize":0,"name":"id","index":0,"comment":"","newDigit":0,"type":"int8","digit":0,"primaryKey":true}],"schemaName":"m","tableName":"m_v1"},"srcDbName":"m"}],"srcDatasourceName":"mm"}],"totalTableMapping":1},"writeMode":"replay"},"name":"writer","category":"writer"}],"version":"2.0","order":{"hops":[{"from":"reader","to":"writer"}]}}

示例

正常返回示例

JSON格式

{
  "Success": true,
  "RequestId": "0bc1411515937635973****",
  "Data": {
    "Status": "success",
    "Message": "fileId:[100] is invalid.",
    "TaskContent": "{\"extend\":{\"mode\":\"migration_holo\",\"resourceGroup\":\"280749\",\"name\":\"h\"},\"type\":\"job\",\"steps\":[{\"stepType\":\"mysql\",\"parameter\":{\"connection\":[{\"datasourceType\":\"mysql\",\"datasource\":\"mm\",\"selectedTables\":[{\"schema\":[{\"tableInfos\":[{\"enable\":true,\"table\":\"m_v1\",\"tableName\":\"m_v1\"}]}],\"dbName\":\"m\"}]}]},\"name\":\"reader\",\"category\":\"reader\"},{\"stepType\":\"holo\",\"parameter\":{\"datasource\":\"h\",\"tableMappingRule\":{\"datasource\":[{\"tableRule\":[{\"srcTable\":\"m_v1\",\"mergeIntoCycleType\":\"DEFAULT\",\"hourDeltaEnable\":false,\"dstTable\":\"m.m_v1\",\"dayDeltaEnable\":false,\"primaryKeyInfo\":{\"column\":[\"id\"],\"type\":\"pk\"},\"dstCreateTableInfo\":{\"indexType\":\"m_v1\",\"dataColumn\":[{\"columnSize\":0,\"name\":\"id\",\"index\":0,\"comment\":\"\",\"newDigit\":0,\"type\":\"int8\",\"digit\":0,\"primaryKey\":true}],\"schemaName\":\"m\",\"tableName\":\"m_v1\"},\"srcDbName\":\"m\"}],\"srcDatasourceName\":\"mm\"}],\"totalTableMapping\":1},\"writeMode\":\"replay\"},\"name\":\"writer\",\"category\":\"writer\"}],\"version\":\"2.0\",\"order\":{\"hops\":[{\"from\":\"reader\",\"to\":\"writer\"}]}}"
  }
}

错误码

HTTP status code错误码错误信息描述
400Param.InvalidThe parameter is invalid.参数错误
403Forbidden.AccessAccess is forbidden.-
500InternalError.SystemAn internal error occurred.内部报错

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