调用QueryDISyncTaskConfigProcessResult接口,通过异步线程ID,获取异步生成创建或更新数据集成同步任务需要的参数。

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

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String QueryDISyncTaskConfigProcessResult

要执行的操作。

ProjectId Long 10000

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

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

TaskType String DI_REALTIME

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

  • DI_REALTIME:表示实时同步任务。
  • DI_SOLUTION:表示解决方案同步任务。

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

RegionId String cn-zhangjiakou

地域信息,通常为服务所在的地域。例如,华东2(上海)为cn-shanghai,华北3(张家口)为cn-zhangjiakou。您无需填写RegionId,会根据调用的Endpoint自动解析。

AsyncProcessId Long 10

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

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

返回数据

名称 类型 示例值 描述
Success Boolean true

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

  • true:成功。
  • false:失败。
RequestId String 0bc1411515937635973****

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

Data Object

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

Status String success

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

  • success:表示成功获取相关参数。
  • fail:表示获取相关参数失败。您可以查看失败原因,处理相关问题。
Message String fileId:[100] is invalid.

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

TaskContent String {"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"}]}}

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

示例

请求示例

http(s)://[Endpoint]/?Action=QueryDISyncTaskConfigProcessResult
&ProjectId=10000
&TaskType=DI_REALTIME
&AsyncProcessId=10
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<QueryDISyncTaskConfigProcessResultResponse>
    <Success>true</Success>
    <RequestId>0bc1411515937635973****</RequestId>
    <Data>
        <Status>success</Status>
        <Message>fileId:[100] is invalid.</Message>
        <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"}]}}</TaskContent>
    </Data>
</QueryDISyncTaskConfigProcessResultResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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\"}]}}"
  }
}

错误码

HttpCode 错误码 错误信息 描述
400 Param.Invalid The parameter is invalid. 参数错误
403 Forbidden.Access Access is forbidden. 没有权限
500 InternalError.System An internal error occurred. 内部报错

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