任务实例--客户数据平台-火山引擎

文档中心

导航

客户数据平台

任务实例

最近更新时间：2023.10.08 10:43:09首次发布时间：2023.10.08 10:43:09

1. 获取任务最近实例

接口说明

接口说明通过本接口，可以获取任务子任务的最新实例id。

请求地址

POST https://{domain}/aeolus/prep/userOpenAPI/v1/task/latestInstance

请求参数

参数名称	类型	默认值	必填	说明
taskId	int		是

请求参数示例

{
    "taskId": 6359
}

返回结果示例

{
  "code": "prep/ok",
  "data": {
      "scheduleInstanceId": 123 // dorado任务实例ID
  },
  "extra_msg": null,
  "msg": "成功"
}

2. 调度任务搜索

接口说明

本接口可以查询调度任务。

请求地址

POST https://{domain}/aeolus/prep/userOpenAPI/v1/task/doradoTaskSearch

请求参数

参数名称	类型	默认值	必填
pageNo	int	1	否
pageSize	int	20	否
category	string	mixed	否
key	string		否
keyword	string		否
frequencySet	array		否
searchForDependencies	boolean		否

请求参数示例

{
    "appId": 555327,
    "pageNo": 1,
    "keyword": "a",
    "frequencySet": []
}

返回结果示例

{
    "code": "prep/ok",
    "message": "成功",
    "extraMsg": null,
    "advice": null,
    "data": null
}

3. 设置任务的回调

接口说明

接口说明通过本接口，可以设置任务的回调信息。

请求地址

POST https://{domain}/aeolus/prep/userOpenAPI/v1/task/callback

请求参数

参数名称	类型	必填
dataSourceType	string	是
dbName	string	是
tableName	string	是
dataTableId	long	是
tableSchemaUpdateCallbackPath	string	是
tableDependencyUpdateCallbackPath	string	是

请求参数示例

{
    "dataSourceType": "click_house",
    "dbName": "aeolus_data_db_cdp_to_test_202207_dev",
    "tableName": "tb_4e8552f7c64dea05e0f9528bd591f28d",
    "dataTableId": 93,
    "tableSchemaUpdateCallbackPath": "/profile_platform/openApi/v2/atlas/labelMeta/syncDataSourceTableMeta?sourceToken=aeolusPrep",
    "tableDependencyUpdateCallbackPath": "/profile_platform/openApi/v2/atlas/labelMeta/modifyDataSourceTablePrepDepends?sourceToken=aeolusPrep"
}

返回结果示例

{
  "code": "prep/ok",
  "data": null,
  "extra_msg": null,
  "msg": "成功"
}

4. 任务手动回溯

接口说明

接口说明通过本接口，执行指定时间范围的任务。

请求地址

POST https://{domain}/aeolus/prep/userOpenAPI/v1/task/execute

请求参数

参数名称	类型	默认值	必填	说明
taskId	int		是
nodeKeys	string[]		是	输出节点的key
startTime	string		是	回溯的时间范围-起始时间格式取决于同步频次 yyyy-MM-dd 默认格式 yyyy-MM-dd HH 小时级 hourly yyyy-MM-dd HH:mm 十分钟级 every_ten_minutes
endTime	string		是	回溯的时间范围-结束时间
skipCheck	boolean	false	否
partitionCheck	boolean	false	否
isSpecifyQueue	boolean	false	否
queueName	string		否

请求参数示例

{
    "taskId": 6359,
    "nodeKeys": ["Load_xxx"],
    "startTime": "2023-02-01",
    "endTime": "2023-02-13"
}

返回结果示例

{
  "code": "prep/ok",
  "data": true,
  "extra_msg": null,
  "msg": "成功"
}