# 1. 创建任务 **接口说明** 通过本接口，可以创建一个Prep任务。 **请求地址** ```Plain Text POST https://{domain}/aeolus/prep/userOpenAPI/v1/task ``` **请求参数** | | | | | | \ |**参数名称** |**类型** |**默认值** |**必填** |**说明** | |---|---|---|---|---| | | | | | | \ |appId |int | |是 | | | | | | | | \ |name |string | |是 | | | | | | | | \ |taskType |int |0 |否 |0 离线；1 实时；2 标签导入任务 | | | | | | | \ |region |string |"" |否 | | | | | | | | \ |parentId |int | |否 | | | | | | | | \ |alarmConf |object | |否 | | | | | | | | \ |dagConf |object | |否 | | | | | | | | \ |scheduleConf |object | |否 | | | | | | | | \ |subTaskConf |object | |否 | | **请求参数示例** ```Plain Text { "appId": 555327, "name": "task_post_0602123456011", "region": "cn", "parentId": 0, "dagConf": { "dag": { "nodes": [ { "key": "Read_aa1_1655653685517", // 节点key "name": "aa1", "type": "Read", // 节点类型，Read输入，Load输出，Filter过滤行，Join连接等 "dataType": "hive", // hive_dataset ch_dataset hive clickhouse等 "nodeStatus": "DEFAULT", "connection": { "clusterName": "cn", "path": "", "dbName": "aaa", "tableName": "aa1", "displayTableName": "aa1", "partitions": [ "e" ] }, // 输入输出节点的数据连接配置 "isDataSetColumn": null, "outputColumns": [ { "name": "w", "type": "string", "originPrepType": "string", "originType": "string", "is_support": 1, "isSelect": true }, { "name": "e", "type": "string", "originPrepType": "string", "originType": "string", "is_support": 1, "isSelect": true } ], // 节点透出的列 "operators": { "filters": { "logic": true, "children": [ { "groupId": 7, "type": "string", "operator": "=", "delimiter": "comma", "operand": [ { "name": "e" }, { "type": "string", "value": "${date}" } ] } ] } }, "params": { "extractType": "{\"key\":\"full\"}", "readNum": "{\"key\":\"sample\",\"value\":\"200\"}" }, "frontendInfo": { "position": { "x": 100, "y": 100 } } } ], "flows": [ { "from": "", // 有向边的头节点key "to": "", // 有向边的尾节点key "fromPort": "", "toPort": "" } ], "frontendInfo": { "layout": "custom", "position": null } } }, "scheduleConf": { "scheduleType": 0, // 调度类型，0手动，1自动调度(dorado调度) "scheduleTimeType": 0, // 运行频率 0: 精确时间; 1: 间隔时间 // 以scheduleTimeSettings= ["13,15,20", "6"]为例 // hourly：13:06、15:06、20:06这三个点进行调度 // daily：每天的13:00、15:00、20:00这三个点进行调度，只取数组的第一个值 // monthly：每月的13,15,20这三天的06:00时间点进行调度 "scheduleFrequency": "hourly", // 调度频率 hourly,daily,weekly, monthly "scheduleTimeSettings": [ "13,15,20", "6" ], // 执行时间：例如分钟级: ["10", "5"]; 小时级: ["13,15,20", "6"]; 周级: ["1,3,4", "02:36"]; 月级: ["16,18,25", "04:27"] "dependencyNodes": [] // 依赖节点 }, // 任务调度配置 "subTaskConf": { "confList": [ { "nodeKey": "", // 输出节点Key "scheduleConf": {}, "advancedParamConf": {}, // 高级参数 "monitorConf": { "alarmRules": [ { "normalNoticeConf": [ { "noticeChannel": "lark", "users": [], // 通知用户 "dutySchedules": [] // 值班计划uk (仅支持域内) 例如:aeolus_dataset } ], // 通知渠道: lark, phone, email, webex "larkGroups": [], // 发送消息到lark群(lark群ID) "emailGroups": [], // 直接发送邮件(邮件地址) "webHookUrl": "", // 推送报警消息的web hook "failedAlarmItems": [ { "item": "fixed_time_not_success", // 运行超时running_timeout, 重试失败retry_failed, 同步任务未开始运行latest_not_start, 同步任务未结束运行latest_not_end, 截止时间同步任务未成功fixed_time_not_success, 结果异常监控项-结果行数result_row_num, 同步超限sync_over_limit "params": { "unit": "", // 单位: hour/minute "interval": "", // 时间间隔 "fixTime": "", // 指定时间 HH:mm "rowNum": "", // 行数 "operator": "" // 操作符: >, =, < } } ], // 失败报警项 "timeoutAlarmItems": [ {} ], // 超时报警项 "resultAlarmItems": [ {} ], // 结果报警项 } ] } } ] }, // 子任务配置 "alarmConf": {} // 监控报警配置 } ``` **返回结果示例** ```Plain Text { "code": "prep/ok", "message": "成功", "extraMsg": null, "advice": null, "data": { "taskId": 9426 } } ``` # 2. 获取任务详情 **接口说明** 通过本接口，可以获取指定的任务的详细信息。 **请求地址** ```Plain Text Get https://{domain}/aeolus/prep/userOpenAPI/v1/task ``` **请求参数** | | | | | | | \ |**参数名称** |**类型** |**默认值** |**必填** |**说明** |**示例** | |---|---|---|---|---|---| | | | | | | | \ |taskId |long | |是 | |6425 | **返回结果示例** ```Plain Text { "code": "prep/ok", "message": "成功", "extraMsg": null, "advice": null, "data": { "task": { "id": 9426, "appId": 555327, "name": "ghs_test_task_post", "ownerEmailPrefix": "guohaishuai", "version": 0, "scheduleType": 1, "taskType": 0, "status": 0, "region": "", "parentId": 0, "taskSource": 0, "previewId": null, "executeStatus": 8, "lastSyncTime": null, "deleteTime": null, "mtime": "2022-06-07 22:35:34", "ctime": "2022-06-07 22:35:33", "node": [], "subTask": [], "baseConf": null, "dagConf": { "dag": { "nodes": [], "flows": [], "frontendInfo": { "layout": "custom", "position": null } }, "outputNode": null, "taskId": 9426, "taskType": 0, "ownerEmailPrefix": "guohaishuai", "taskTime": null, "frequency": null, "paramConf": null, "appId": 555327 }, "alarmConf": null, "scheduleConf": { "scheduleType": 0, "scheduleTimeType": 0, "scheduleFrequency": null, "scheduleTimeSettings": [], "interval": null, "intervalUnit": null, "dependencyNodes": [], "clusterId": null, "queue": null, "priority": null }, "advancedParamConf": null, "subTaskConf": { "confList": [] } }, "latestInstance": null, "actions": [ "admin" ] } } ``` # 3. 更新任务 **接口说明** 通过本接口，可以对已有的任务进行更新。 **请求地址** ```Plain Text PUT https://{domain}/aeolus/prep/userOpenAPI/v1/task ``` **请求参数** | | | | | | \ |**参数名称** |**类型** |**默认值** |**必填** |**说明** | |---|---|---|---|---| | | | | | | \ |appId |int | |是 | | | | | | | | \ |id |int | |是 | | | | | | | | \ |name |string | |是 | | | | | | | | \ |taskType |int | |否 | | | | | | | | \ |parentId |int | |否 | | | | | | | | \ |taskSource |int | |否 | | | | | | | | \ |alarmConf |object | |否 | | | | | | | | \ |dagConf |object | |是 | | | | | | | | \ |subTaskConf |object | |否 | | | | | | | | \ |scheduleConf |object | |否 | | **请求参数示例** ```Plain Text { "appId": 555327, "id": 6087, "previewId": null, "parentId": 0, "taskType": 0, "name": "task_post_0615", "region": "cn", "dagConf": { "dag": { "nodes": [ { "key": "Read_524get_test_1655227481185", "name": "524get_test", "type": "Read", "dataType": "restapi", "nodeStatus": "DEFAULT", "connection": { "clusterName": "cn", "dataSourceId": 185, "path": "", "dbName": "524get_test", "tableName": "524get_test", "displayTableName": "524get_test", "partitions": [] }, "outputColumns": [ { "name": "city", "type": "string", "originPrepType": "string", "originType": "string", "is_support": 1, "isSelect": true }, { "name": "weather", "type": "string", "originPrepType": "string", "originType": "string", "is_support": 1, "isSelect": true } ], "operators": { "filters": {} }, "params": { "extractType": "{\"key\":\"full\"}", "readNum": "{\"key\":\"sample\",\"value\":\"200\"}" }, "frontendInfo": { "position": { "x": 100, "y": 100 } } } ], "flows": [], "frontendInfo": { "layout": "custom", "position": null } } }, "scheduleConf": { "scheduleType": 0, "dependencyNodes": [] }, "subTaskConf": { "confList": [] }, "alarmConf": {} } ``` **返回结果示例** ```Plain Text { "code": "prep/ok", "message": "成功", "extraMsg": null, "advice": null, "data": { "taskId": 9426 } } ``` # 4. 更新任务基本信息 **接口说明** 通过本接口，可以更新任务名称。 **请求地址** ```Plain Text PATCH https://{domain}/aeolus/prep/userOpenAPI/v1/task ``` **请求参数** | | | | | | \ |**参数名称** |**类型** |**默认值** |**必填** |**说明** | |---|---|---|---|---| | | | | | | \ |appId |int | |是 | | | | | | | | \ |id |int | |是 | | | | | | | | \ |name |string | |是 | | **请求参数示例** ```Plain Text { "appId": 555327, "id": 6087, "name": "task_post_06151234" } ``` **返回结果示例** ```Plain Text { "code": "prep/ok", "message": "成功", "extraMsg": null, "advice": null, "data": { "taskId": 6087 } } ``` # 5. 将任务放入回收站 **接口说明** 通过本接口，可以将指定的任务放入回收站中。 **请求地址** ```Plain Text POST https://{domain}/aeolus/prep/userOpenAPI/v1/task/recycleTask ``` **请求参数** | | | | | | \ |**参数名称** |**类型** |**默认值** |**必填** |**说明** | |---|---|---|---|---| | | | | | | \ |appId |int | |是 | | | | | | | | \ |taskIdList |array | |是 | | **请求参数示例** ```Plain Text { "appId": 555327, "taskIdList": [ 6087 ] } ``` **返回结果示例** ```Plain Text { "code": "prep/ok", "message": "成功", "extraMsg": null, "advice": null, "data": null } ``` # 6. 将任务从回收站恢复 **接口说明** 通过本接口，可以将任务从回收站恢复。 **请求地址** ```Plain Text POST https://{domain}/aeolus/prep/userOpenAPI/v1/task/restoreTask ``` **请求参数** | | | | | | \ |**参数名称** |**类型** |**默认值** |**必填** |**说明** | |---|---|---|---|---| | | | | | | \ |appId |int | |是 | | | | | | | | \ |taskIdList |array | |是 | | **请求参数示例** ```Plain Text { "appId": 555327, "taskIdList": [ 6087 ] } ``` **返回结果示例** ```Plain Text { "code": "prep/ok", "message": "成功", "extraMsg": null, "advice": null, "data": null } ``` # 7. 将任务彻底删除 **接口说明** 通过本接口，可以将指定任务彻底删除。 **请求地址** ```Plain Text DELETE https://{domain}/aeolus/prep/userOpenAPI/v1/task ``` **请求参数** | | | | | | \ |**参数名称** |**类型** |**默认值** |**必填** |**说明** | |---|---|---|---|---| | | | | | | \ |appId |int | |是 | | | | | | | | \ |taskIdList |array | |是 | | **请求参数示例** ```Plain Text { "appId": 555327, "taskIdList": [ 6089 ] } ``` **返回结果示例** ```Plain Text { "code": "prep/ok", "message": "成功", "extraMsg": null, "advice": null, "data": null } ``` # 8. 更改任务的Owner **接口说明** 接口说明通过本接口，可以获取指定用户的访问Token **请求地址** ```Plain Text POST https://{domain}/aeolus/prep/userOpenAPI/v1/task/updateOwner ``` **请求参数** | | | | | | \ |**参数名称** |**类型** |**默认值** |**必填** |**说明** | |---|---|---|---|---| | | | | | | \ |taskId |int | |是 | | | | | | | | \ |owner |string | |是 |需要更改的owner | **请求参数示例** ```Plain Text { "owner": "guohaishuai", "taskId": 6091 } ``` **返回结果示例** ```Plain Text { "code": "prep/ok", "message": "成功", "extraMsg": null, "advice": null, "data": null } ``` # 9. 获取子任务实例列表 **接口说明** 本接口通过taskId以及各种过滤条件来查询taskId对应任务包含的子任务实例列表。 **请求地址** ```Plain Text GET https://{domain}/aeolus/prep/userOpenAPI/v1/task/subTaskInfoList ``` **请求参数** | | | | | | | \ |**参数名称** |**类型** |**默认值** |**必填** |**说明** |**示例** | |---|---|---|---|---|---| | | | | | | | \ |taskId |long | |是 | |6218 | | | | | | | | \ |pageNo |long | |否 | |1 | | | | | | | | \ |pageSize |long | |否 | |30 | | | | | | | | \ |startTaskTime |string | |否 | |2022-06-14 | | | | | | | | \ |endTaskTime |string | |否 | |2022-06-21 | | | | | | | | \ |insStatus |string | |否 | |default | | | | | | | | \ |sortColumns |string | |否 | |taskTime | | | | | | | | \ |sortOrders |string | |否 | |desc | | | | | | | | \ |outputKW |string | |否 | | | | | | | | | | \ |refresh |boolean | |否 | |0 | **返回结果示例** ```Plain Text { "code": "prep/ok", "message": "成功", "extraMsg": null, "advice": null, "data": { "total": 1, "list": [ { "statusDescCode": 30, "runType": 10, "parentRelationNodes": null, "runTypeAlias": "rerun", "businessId": null, "isBinlogDump": null, "type": "shell", "adminUserOrDepartmentNames": null, "frequency": "daily", "scheduleIp": "2", "loopCount": null, "lookbackNotes": null, "id": 988525416, "flow": false, "consumeTime": "3m21s", "slaTime": null, "taskTimeFormat": "2022-06-07 00:00", "earliestBackfillTime": null, "level": null, "triggerId": 8429044, "priority": "normal", "workName": null, "version": 1, "doradoReturnConsumeTime": "3m 31s ", "avgConsumeTime": null, "lookbackNoteType": "allow", "tags": [], "node": { "nodeName": "输出_1", "partitions": [ "p_date" ], "dataSetStatus": 0, "dbName": "aeolus_data_db_cnch_alpha_lq_202205_dev", "clusterName": "cnch_alpha_lq", "nodeKey": "Load_1653407900667", "nodeType": "table", "dataSourceType": "click_house", "tableName": "tb_3197f539dc1d593e4201082628b5ba5e", "status": 0 }, "submitTime": "2022-06-08 10:18:40", "dependencyType": "depend_upstream_all", "sourceType": null, "name": "su_test_任务数量限制_load_1653407900667_fc57", "frequencyName": "天级", "diagPageUrl": "https://data.bytedance.net/dorado/instance-detail/diagnosis?project=cn_756&id=105917769&schedule=2022-06-07%2000%3A00%3A00&pid=756&status=4&instanceId=988525416&groupName=cn", "region": "cn", "projectName": null, "projectId": 756, "syncStatus": 4, "status": 4, "scheduleRunTime": "2022-06-08 00:00:00", "instanceKey": "880ab9db0a2e992933ef0c3ddd4f2c9d", "virtual": false, "cautionConfirmType": "default", "roles": null, "statusAlias": "succeed", "slaOffset": null, "ownerDisplayName": "sushiyan.test", "clusterName": null, "startTime": "2022-06-08 10:18:50", "runCount": 1, "flowId": -1, "owner": "sushiyan.test", "hasAuth": null, "flowTaskId": -1, "statusDesc": "执行成功", "retryCount": 0, "inputParams": [ { "hasAuth": null, "flowTaskId": null, "debugVal": null, "description": null, "type": "task_custom", "name": "back_track_queue", "typeString": null, "isFlow": null, "taskName": null, "projectName": null, "projectId": null, "value": "back_track_queue", "taskId": null, "order": null, "paramValue": "#" } ], "logPageUrl": "https://data.bytedance.net/dorado/instance-detail/log?project=cn_756&id=105917769&schedule=2022-06-07%2000%3A00%3A00&pid=756&instanceId=988525416&groupName=cn", "relationId": -1276131694, "workId": "104", "cronExpression": "0 0 * * *", "schedule": "2022-06-07 00:00:00", "distanceToBaseIns": null, "createTime": "2022-06-08 10:18:39.000", "location": "cn", "endTime": "2022-06-08 10:22:11", "syncStatusDescCode": 30, "taskId": 105917769, "queue": null, "dc": null } ] } } ``` # 10. 获取任务和文件夹 **接口说明：** 接口说明通过本接口，可以获取任务和文件夹 **请求地址** ```Plain Text POST https://{domain}/aeolus/prep/userOpenAPI/v1/task/allTaskOrDirectory ``` **请求参数** | | | | | | | \ |**参数名称** |**类型** |**默认值** |**必填** |**说明** |**示例** | |---|---|---|---|---|---| | | | | | | | \ |appId |long | |是 | |555327 | | | | | | | | \ |owner |string | |否 | |guohaishuai | | | | | | | | \ |kw |string | |否 | |a | | | | | | | | \ |resType |int | |否 |0 task; 1 文件夹 |0 | | | | | | | | \ |resIds |Array | |否 |数组元素是long | | | | | | | | | \ |kwMatchId |boolean |true |否 | | | | | | | | | | \ |taskSource |int |0 |否 |resId为空时staskSource才生效 | | **返回结果示例** ```Plain Text { "code": "prep/ok", "message": "成功", "extraMsg": null, "advice": null, "data": [ { "appId": 555327, "resType": 0, "id": 1109, "parentId": 0, "name": "test_w_003", "ownerEmailPrefix": "wanghanqi.john", "taskType": 0, "actions": [], "taskSource": 0 } ] } ``` # 11. 获取项目下全部任务 **接口说明：** 接口说明通过本接口，可以获取全部文件夹列表。 **请求地址** ```Plain Text POST https://{domain}/aeolus/prep/userOpenAPI/v1/task/allTaskDirectory ``` **请求参数** | | | | | | | \ |**参数名称** |**类型** |**默认值** |**必填** |**说明** |**示例** | |---|---|---|---|---|---| | | | | | | | \ |appId |long | |是 | |555327 | | | | | | | | \ |status |int |0 |否 | |0 | | | | | | | | \ |struct |string | |否 | |tree | | | | | | | | \ |kw |string | |否 | | | | | | | | | | \ |emailPrefix |string | |否 | | | | | | | | | | \ |isMine |boolean |false |否 | | | | | | | | | | \ |needActions |boolean |false |否 | | | **返回结果示例** ```Plain Text { "code": "prep/ok", "message": "成功", "extraMsg": null, "advice": null, "data": [ { "appId": 555327, "resType": 1, "id": 164, "parentId": 0, "name": "yuqi测试文件夹", "ownerEmailPrefix": "wangyuqi.yuki2", "children": [ { "appId": 555327, "resType": 0, "id": 5653, "parentId": 164, "name": "yuqi20220510prep1", "ownerEmailPrefix": "wangyuqi.yuki2", "taskType": 0, "actions": [], "taskSource": 0 } ], "actions": [], "taskSource": 0 }, { "appId": 555327, "resType": 0, "id": 1109, "parentId": 0, "name": "test_w_003", "ownerEmailPrefix": "wanghanqi.john", "taskType": 0, "actions": [], "taskSource": 0 } ] } ``` # 12. 获取任务依赖列表 **接口说明：** 接口说明通过本接口，可以获取任务的依赖列表。 **请求地址** ```Plain Text POST https://{domain}/aeolus/prep/userOpenAPI/v1/task/dependencyList ``` **请求参数** | | | | | | \ |**参数名称** |**类型** |**默认值** |**必填** |**说明** | |---|---|---|---|---| | | | | | | \ |appId |int | |是 | | | | | | | | \ |id |int | |是 | | | | | | | | \ |dagConf |object | |是 | | | | | | | | \ |scheduleConf |object | |否 | | **请求参数示例** ```Plain Text { "appId": 555327, "id": 6176, "dagConf": { "dag": { "nodes": [ { "key": "Read_aa1_1655653685517", "name": "aa1", "type": "Read", "dataType": "hive", "nodeStatus": "DEFAULT", "connection": { "dataSourceId": null, "prepDataSetId": null, "datasetName": "", "fileId": null, "contentType": null, "path": null, "host": null, "port": null, "user": null, "password": null, "catalogName": null, "dbName": "aaa", "driverName": null, "tableName": "aa1", "sql": null, "oriSql": null, "dataSetIdList": null, "partitions": [ "e" ], "encryptMethod": 0, "additionalParamsStr": null, "jdbcConnectionString": null, "shardNum": 0, "chPartitionType": null, "clusterName": "cn", "shardColumn": null, "bootstrapServers": null, "topicName": null, "groupId": null, "checkpointLocation": null, "displayTableName": "aa1" }, "sampleJson": null, "isDataSetColumn": null, "outputColumns": [ { "name": "w", "type": "string", "originType": "string", "is_support": 1, "isSelect": true }, { "name": "e", "type": "string", "originType": "string", "is_support": 1, "isSelect": true } ], "operators": { "filters": { "logic": true, "children": [ { "type": "string", "operator": "=", "operand": [ { "name": "e" }, { "type": "string", "value": "${date}" } ], "children": [] } ] } }, "params": { "extractType": "{\"key\":\"full\"}", "readNum": "{\"key\":\"sample\",\"value\":\"200\"}" }, "advanceSettings": [], "frontendInfo": { "layout": null, "position": { "x": 100, "y": 100 } } }, { "key": "Load_1655922578812", "name": "输出_1", "type": "Load", "dataType": "hive_dataset", "nodeStatus": "DEFAULT", "frontendInfo": { "position": { "x": 320, "y": 100 } } } ], "flows": [ { "from": "Read_aa1_1655653685517", "to": "Load_1655922578812", "fromPort": "output", "toPort": "input" } ], "frontendInfo": { "layout": "custom", "position": null } } }, "scheduleConf": { "dependencyNodes": [ { "nodeKey": "Load_1655922578812", "dependencyMethod": 0 } ] } } ``` **返回结果示例** ```Plain Text { "code": "prep/ok", "message": "成功", "extraMsg": null, "advice": null, "data": [ { "nodeKey": "Load_1654621564155", "nodeName": "输出_1", "dependencies": [ { "dbName": "dm_lab_speech", "tableName": "ailab_speech_mdd_session_all", "dataType": "hive", "subTasks": [ { "id": 105561278, "nodeKey": null, "nodeName": null, "taskId": null, "taskName": "HPSensor_dm_lab_speech.ailab_speech_mdd_session_all_#1", "source": "raw_data", "frequency": null, "scheduleConf": { "scheduleType": 1, "scheduleTimeType": 0, "scheduleFrequency": "daily", "scheduleTimeSettings": [], "interval": null, "intervalUnit": 0 }, "offsetInfo": { "offsets": [ 0 ], "offsetType": "set", "offsetFrequency": "daily" }, "mtime": null, "dependencyStatus": 1, "dependencyType": 1, "recommendTaskInfo": { "projectId": 5, "databaseName": "dm_lab_speech", "tableName": "ailab_speech_mdd_session_all", "frequency": "daily", "path": "date=${date}/", "type": "hive_partition-sensor", "taskPartitions": [ { "value": "${date}", "key": "date" } ] } } ], "inputNodes": [ { "nodeKey": "Read_ailab_speech_mdd_session_all_1653926328437", "nodeName": "ailab_speech_mdd_session_all" } ], "readPartitionInfo": { "logic": true, "type": null, "operator": null, "operand": null, "children": [ { "logic": null, "type": "string", "operator": "=", "operand": [ { "name": "date", "distinct": false }, { "type": "string", "value": "${date}", "distinct": false } ], "children": [] } ] } } ], "nodeDepStatus": 1, "dependencyMethod": 0, "filterUnCompleteSensor": null, "isSelfDepend": false, "earliestBackTime": null } ] } ``` # 13. 获取预览数据 **接口说明：** 接口说明通过本接口，可以获取任务的预览数据。 **请求地址** ```Plain Text POST https://{domain}/aeolus/prep/userOpenAPI/v1/task/previewSample ``` **请求参数** | | | | | | \ |**参数名称** |**类型** |**默认值** |**必填** |**说明** | |---|---|---|---|---| | | | | | | \ |appId |int | |是 | | | | | | | | \ |dagConf |object | |是 | | | | | | | | \ |ownerEmailPrefix |string | |是 | | **请求参数示例** ```Plain Text { "ownerEmailPrefix": "guohaishuai", "dagConf": { "dag": { "nodes": [ { "outputColumns": [ { "name": "city", "originType": "string", "namespace": "cn_185_185", "hasColPriviledge": null, "value": null, "alias": null, "isSelect": true, "type": "string" }, { "name": "weather", "originType": "string", "namespace": "cn_185_185", "hasColPriviledge": null, "value": null, "alias": null, "isSelect": true, "type": "string" } ], "name": "cn_185_185", "nodeStatus": null, "operators": {}, "connection": { "shardNum": 0, "prepDataSetId": null, "contentType": 0, "clusterName": "cn", "dataSourceType": "restapi", "chPartitionType": null, "tableName": "185", "dbName": "185", "dataSourceId": 185, "user": null, "sql": "", "path": null, "catalogName": null, "prepDataSourceType": null, "shardColumn": null, "partitions": [] }, "subTaskId": null, "dataType": "restapi", "advanceSettings": [], "taskTime": null, "key": "cn_185_185", "params": { "extractType": "{\"key\":\"full\"}" }, "type": "Read" }, { "name": "Reset_6889166e1656523502071", "dataType": "Column", "operators": { "fields": [ { "name": "city", "type": "string", "namespace": "cn_185_185", "hasColPriviledge": null, "value": null, "alias": "city", "isSelect": true, "originType": "string" }, { "name": "weather", "type": "string", "namespace": "cn_185_185", "hasColPriviledge": null, "value": null, "alias": "weather", "isSelect": true, "originType": "string" } ], "preNodes": [], "filters": {}, "joinNodes": [] }, "nodeStatus": "DEFAULT", "key": "Reset_6889166e1656523502071", "type": "Reset" } ], "flows": [ { "toPort": "input", "to": "Reset_6889166e1656523502071", "from": "cn_185_185", "fromPort": "output" } ] }, "outputNode": { "key": "Reset_6889166e1656523502071" } }, "appId": 555327 } ``` **返回结果示例** ```Plain Text { "code": "prep/ok", "message": "成功", "extraMsg": null, "advice": null, "data": [ { "type": "data", "name": "output", "type": "data", "data": { "values": [ [ "东城区", "阴" ] ], "fields": [ { "name": "city", "type": "string", "comment": null, "metadata": {} }, { "name": "weather", "type": "string", "comment": null, "metadata": {} } ] }, "total": 0, "size": 0, "exceed": null } ] } ``` # 14. 更新标签任务 **接口说明** 接口说明通过本接口，可以更新标签任务。 **请求地址** ```Plain Text PUT https://{domain}/aeolus/prep/userOpenAPI/v1/task/labelTask ``` **请求参数** | | | | | | \ |**参数名称** |**类型** |**默认值** |**必填** |**说明** | |---|---|---|---|---| | | | | | | \ |labelId |long | |是 | | | | | | | | \ |prepId |long | |是 | | | | | | | | \ |nodeKey |string | |是 | | | | | | | | \ |labelType |string | |是 | | | | | | | | \ |labelName |string | |是 | | | | | | | | \ |devId |long | |否 | | | | | | | | \ |task |object | |是 | | | | | | | | \ |labelEntityType |string | |否 | | **请求参数示例** ```Plain Text { "labelId": 378, "prepId": 6450, "nodeKey": "load_label_1644228589459", "labelType": "string", "labelName": "age", "devId": null, "task": { "id": 4388, "appId": 1001326, "name": "测试新需求", "ownerEmailPrefix": "tangying.ty", "version": 22, "scheduleType": 1, "taskType": 0, "status": 0, "region": "cn", "parentId": 0, "taskSource": 0, "previewId": "beff68c7-fb0c-42db-88e0-ae65d0e699ab", "executeStatus": 5, "lastSyncTime": "2022-07-12 00:22:01", "deleteTime": null, "mtime": "2022-07-12 00:22:08", "ctime": "2022-01-05 18:29:43", "baseConf": null, "dagConf": { "dag": { "nodes": [ { "name": "user_cdp", "type": "Read", "nodeStatus": "SUCCEEDED", "subTaskId": null, "dataType": "hive", "taskTime": "2022-07-11T00:00:00.000+0800", "key": "Read_user_cdp_1641378601419", "connection": { "dataSourceId": null, "prepDataSetId": null, "datasetName": "", "dataSourceType": "hive", "fileId": null, "contentType": null, "path": null, "host": null, "port": null, "user": null, "password": null, "catalogName": null, "dbName": "cdp", "driverName": null, "tableName": "user_cdp", "sql": null, "oriSql": null, "dataSetIdList": null, "partitions": [ "p_date=undefined" ], "encryptMethod": 0, "additionalParams": null, "additionalParamsStr": null, "jdbcConnectionString": null, "shardNum": 0, "chPartitionType": null, "clusterName": "cn", "shardColumn": null, "bootstrapServers": null, "topicName": null, "groupId": null, "checkpointLocation": null, "displayTableName": "user_cdp" }, "outputColumns": [ { "name": "user_id", "type": "long", "originType": "bigint", "isSelect": true, "isAutoDataType": false }, { "name": "gender", "type": "string", "originType": "string", "isSelect": true, "isAutoDataType": false }, { "name": "age", "type": "string", "originType": "string", "isSelect": true, "isAutoDataType": false }, { "name": "edu", "type": "string", "originType": "string", "isSelect": true, "isAutoDataType": false }, { "name": "duozhi", "type": "array", "originType": "array", "isSelect": true, "isAutoDataType": false }, { "name": "birthday", "type": "string", "originType": "string", "isSelect": true, "isAutoDataType": false }, { "name": "birthdaytime", "type": "string", "originType": "string", "isSelect": true, "isAutoDataType": false }, { "name": "xiaoshu", "type": "string", "originType": "string", "isSelect": true, "isAutoDataType": false }, { "name": "job", "type": "string", "originType": "string", "isSelect": true, "isAutoDataType": false }, { "name": "marry", "type": "string", "originType": "string", "isSelect": true, "isAutoDataType": false }, { "name": "phone", "type": "string", "originType": "string", "isSelect": true, "isAutoDataType": false }, { "name": "phoneid", "type": "string", "originType": "string", "isSelect": true, "isAutoDataType": false }, { "name": "price", "type": "string", "originType": "string", "isSelect": true, "isAutoDataType": false }, { "name": "operater", "type": "string", "originType": "string", "isSelect": true, "isAutoDataType": false }, { "name": "recent_city", "type": "string", "originType": "string", "isSelect": true, "isAutoDataType": false }, { "name": "city", "type": "string", "originType": "string", "isSelect": true, "isAutoDataType": false }, { "name": "city_level", "type": "string", "originType": "string", "isSelect": true, "isAutoDataType": false }, { "name": "base_id", "type": "long", "originType": "bigint", "isSelect": true, "isAutoDataType": false }, { "name": "p_date", "type": "string", "originType": "string", "isSelect": true, "isAutoDataType": false } ], "inputColumns": null, "sampleJson": null, "engineType": null, "startStatistic": false, "operators": { "filters": { "logic": true, "type": "string", "operator": null, "operand": [], "children": [ { "logic": null, "type": "string", "operator": "=", "operand": [ { "name": "p_date", "isAutoDataType": false, "distinct": false }, { "type": "string", "value": "2021-09-01", "isAutoDataType": false, "distinct": false } ], "children": [] } ] }, "fields": null, "group": null, "joinNodes": null, "preNodes": null, "preNodeInfos": null, "replaceColumn": null, "flows": null, "joinConfs": null, "unpivotConf": null, "mapColumnInfoList": null, "pivotConf": null }, "advanceSettings": [], "frontendInfo": { "layout": null, "position": { "x": 100, "y": 100 } }, "isDataSetColumn": false, "params": { "extractType": "{\"key\":\"full\"}", "readNum": "{\"key\":\"sample\",\"value\":\"200\"}" } }, { "name": "计算列_1", "type": "Add", "nodeStatus": "SUCCEEDED", "subTaskId": null, "dataType": "Expr", "taskTime": null, "key": "compute_col_1641378637652", "connection": null, "outputColumns": null, "inputColumns": null, "sampleJson": null, "engineType": null, "startStatistic": false, "operators": { "filters": null, "fields": [ { "name": "pdate", "type": "date", "value": "base64;e1RBU0tfREFURX0=", "isAutoDataType": false, "distinct": false } ], "group": null, "joinNodes": null, "preNodes": null, "preNodeInfos": null, "replaceColumn": null, "flows": null, "joinConfs": null, "unpivotConf": null, "mapColumnInfoList": null, "pivotConf": null }, "advanceSettings": null, "frontendInfo": { "layout": null, "position": { "x": 320, "y": 100 } }, "isDataSetColumn": false, "params": {} }, { "name": "字段设置_1", "type": "Reset", "nodeStatus": "SUCCEEDED", "subTaskId": null, "dataType": "Column", "taskTime": null, "key": "reset_column_1641378677857", "connection": null, "outputColumns": null, "inputColumns": null, "sampleJson": null, "engineType": null, "startStatistic": false, "operators": { "filters": null, "fields": [ { "name": "user_id", "type": "long", "originType": "long", "alias": "user_id", "isSelect": true, "isAutoDataType": false, "distinct": false }, { "name": "gender", "type": "string", "originType": "string", "alias": "gender", "isSelect": true, "isAutoDataType": false, "distinct": false }, { "name": "age", "type": "string", "originType": "string", "alias": "age", "isSelect": true, "isAutoDataType": false, "distinct": false }, { "name": "edu", "type": "string", "originType": "string", "alias": "edu", "isSelect": true, "isAutoDataType": false, "distinct": false }, { "name": "duozhi", "type": "array", "originType": "array", "alias": "duozhi", "isSelect": true, "isAutoDataType": false, "distinct": false }, { "name": "birthday", "type": "date", "originType": "string", "alias": "birthday", "isSelect": true, "isAutoDataType": false, "distinct": false }, { "name": "birthdaytime", "type": "timestamp", "originType": "string", "alias": "birthdaytime", "isSelect": true, "isAutoDataType": false, "distinct": false }, { "name": "xiaoshu", "type": "string", "originType": "string", "alias": "xiaoshu", "isSelect": true, "isAutoDataType": false, "distinct": false }, { "name": "job", "type": "string", "originType": "string", "alias": "job", "isSelect": true, "isAutoDataType": false, "distinct": false }, { "name": "marry", "type": "string", "originType": "string", "alias": "marry", "isSelect": true, "isAutoDataType": false, "distinct": false }, { "name": "phone", "type": "string", "originType": "string", "alias": "phone", "isSelect": true, "isAutoDataType": false, "distinct": false }, { "name": "phoneid", "type": "string", "originType": "string", "alias": "phoneid", "isSelect": true, "isAutoDataType": false, "distinct": false }, { "name": "price", "type": "string", "originType": "string", "alias": "price", "isSelect": true, "isAutoDataType": false, "distinct": false }, { "name": "operater", "type": "string", "originType": "string", "alias": "operater", "isSelect": true, "isAutoDataType": false, "distinct": false }, { "name": "recent_city", "type": "string", "originType": "string", "alias": "recent_city", "isSelect": true, "isAutoDataType": false, "distinct": false }, { "name": "city", "type": "string", "originType": "string", "alias": "city", "isSelect": true, "isAutoDataType": false, "distinct": false }, { "name": "city_level", "type": "string", "originType": "string", "alias": "city_level", "isSelect": true, "isAutoDataType": false, "distinct": false }, { "name": "base_id", "type": "long", "originType": "long", "alias": "base_id", "isSelect": true, "isAutoDataType": false, "distinct": false }, { "name": "p_date", "type": "string", "originType": "string", "alias": "p_date", "isSelect": true, "isAutoDataType": false, "distinct": false }, { "name": "pdate", "type": "date", "originType": "date", "alias": "pdate", "isSelect": true, "isAutoDataType": false, "distinct": false } ], "group": null, "joinNodes": null, "preNodes": null, "preNodeInfos": null, "replaceColumn": null, "flows": null, "joinConfs": null, "unpivotConf": null, "mapColumnInfoList": null, "pivotConf": null }, "advanceSettings": null, "frontendInfo": { "layout": null, "position": { "x": 540, "y": 100 } }, "isDataSetColumn": false, "params": {} }, { "name": "输出标签_1", "type": "load_label", "nodeStatus": "DEFAULT", "subTaskId": null, "dataType": "", "taskTime": null, "key": "load_label_1641378693437", "connection": { "dataSourceId": null, "prepDataSetId": null, "datasetName": "", "dataSourceType": "click_house", "fileId": null, "contentType": null, "path": null, "host": null, "port": null, "user": null, "password": null, "catalogName": null, "dbName": "cdp_internal", "driverName": null, "tableName": "tag_data_source", "sql": null, "oriSql": null, "dataSetIdList": null, "partitions": null, "encryptMethod": 1, "additionalParams": null, "additionalParamsStr": null, "jdbcConnectionString": null, "shardNum": 0, "chPartitionType": null, "clusterName": "cdp_to_test", "shardColumn": null, "bootstrapServers": null, "topicName": null, "groupId": null, "checkpointLocation": null, "displayTableName": null }, "outputColumns": null, "inputColumns": null, "sampleJson": null, "engineType": null, "startStatistic": false, "operators": { "filters": null, "fields": null, "group": null, "joinNodes": null, "preNodes": null, "preNodeInfos": null, "replaceColumn": null, "flows": null, "joinConfs": null, "unpivotConf": null, "mapColumnInfoList": null, "pivotConf": null }, "advanceSettings": null, "frontendInfo": { "layout": null, "position": { "x": 760, "y": 100 } }, "isDataSetColumn": false, "params": { "labelEntityType": "主体1", "chloadColumnKeys": "base_id", "chloadColumns": "birthday", "labelName": "模型日期1", "labelDesc": null, "dataSecurityLevel": "L3", "isOnlineApiService": "false" } }, { "name": "输出标签_2", "type": "load_label", "nodeStatus": "DEFAULT", "subTaskId": null, "dataType": "", "taskTime": null, "key": "load_label_1641379037544", "connection": { "dataSourceId": null, "prepDataSetId": null, "datasetName": "", "dataSourceType": "click_house", "fileId": null, "contentType": null, "path": null, "host": null, "port": null, "user": null, "password": null, "catalogName": null, "dbName": "cdp_internal", "driverName": null, "tableName": "tag_data_source", "sql": null, "oriSql": null, "dataSetIdList": null, "partitions": null, "encryptMethod": 1, "additionalParams": null, "additionalParamsStr": null, "jdbcConnectionString": null, "shardNum": 0, "chPartitionType": null, "clusterName": "cdp_to_test", "shardColumn": null, "bootstrapServers": null, "topicName": null, "groupId": null, "checkpointLocation": null, "displayTableName": null }, "outputColumns": null, "inputColumns": null, "sampleJson": null, "engineType": null, "startStatistic": false, "operators": { "filters": null, "fields": null, "group": null, "joinNodes": null, "preNodes": null, "preNodeInfos": null, "replaceColumn": null, "flows": null, "joinConfs": null, "unpivotConf": null, "mapColumnInfoList": null, "pivotConf": null }, "advanceSettings": null, "frontendInfo": { "layout": null, "position": { "x": 760, "y": 220 } }, "isDataSetColumn": false, "params": { "labelEntityType": "主体1", "chloadColumnKeys": "base_id", "chloadColumns": "birthdaytime", "labelName": "模型日期时间1", "labelDesc": null, "dataSecurityLevel": "L4", "isOnlineApiService": "false" } }, { "name": "输出标签_3", "type": "load_label", "nodeStatus": "DEFAULT", "subTaskId": null, "dataType": "", "taskTime": null, "key": "load_label_1641379268973", "connection": { "dataSourceId": null, "prepDataSetId": null, "datasetName": "", "dataSourceType": "click_house", "fileId": null, "contentType": null, "path": null, "host": null, "port": null, "user": null, "password": null, "catalogName": null, "dbName": "cdp_internal", "driverName": null, "tableName": "tag_data_source", "sql": null, "oriSql": null, "dataSetIdList": null, "partitions": null, "encryptMethod": 1, "additionalParams": null, "additionalParamsStr": null, "jdbcConnectionString": null, "shardNum": 0, "chPartitionType": null, "clusterName": "cdp_to_test", "shardColumn": null, "bootstrapServers": null, "topicName": null, "groupId": null, "checkpointLocation": null, "displayTableName": null }, "outputColumns": null, "inputColumns": null, "sampleJson": null, "engineType": null, "startStatistic": false, "operators": { "filters": null, "fields": null, "group": null, "joinNodes": null, "preNodes": null, "preNodeInfos": null, "replaceColumn": null, "flows": null, "joinConfs": null, "unpivotConf": null, "mapColumnInfoList": null, "pivotConf": null }, "advanceSettings": null, "frontendInfo": { "layout": null, "position": { "x": 760, "y": -20 } }, "isDataSetColumn": false, "params": { "labelEntityType": "主体1", "chloadColumnKeys": "base_id", "chloadColumns": "marry", "labelName": "模型文本marry", "labelDesc": null, "dataSecurityLevel": "L3", "isOnlineApiService": "false" } }, { "name": "输出标签_4", "type": "load_label", "nodeStatus": "DEFAULT", "subTaskId": null, "dataType": "", "taskTime": null, "key": "load_label_1641435899933", "connection": { "dataSourceId": null, "prepDataSetId": null, "datasetName": "", "dataSourceType": "click_house", "fileId": null, "contentType": null, "path": null, "host": null, "port": null, "user": null, "password": null, "catalogName": null, "dbName": "cdp_internal", "driverName": null, "tableName": "tag_data_source", "sql": null, "oriSql": null, "dataSetIdList": null, "partitions": null, "encryptMethod": 1, "additionalParams": null, "additionalParamsStr": null, "jdbcConnectionString": null, "shardNum": 0, "chPartitionType": null, "clusterName": "cdp_to_test", "shardColumn": null, "bootstrapServers": null, "topicName": null, "groupId": null, "checkpointLocation": null, "displayTableName": null }, "outputColumns": null, "inputColumns": null, "sampleJson": null, "engineType": null, "startStatistic": false, "operators": { "filters": null, "fields": null, "group": null, "joinNodes": null, "preNodes": null, "preNodeInfos": null, "replaceColumn": null, "flows": null, "joinConfs": null, "unpivotConf": null, "mapColumnInfoList": null, "pivotConf": null }, "advanceSettings": null, "frontendInfo": null, "isDataSetColumn": false, "params": { "labelEntityType": "主体1", "chloadColumnKeys": "base_id", "chloadColumns": "job", "labelName": "模型文本phone改job3#", "labelDesc": null, "dataSecurityLevel": "L3", "isOnlineApiService": "false" } } ], "flows": [ { "from": "Read_user_cdp_1641378601419", "to": "compute_col_1641378637652", "fromPort": "output", "toPort": "input" }, { "from": "compute_col_1641378637652", "to": "reset_column_1641378677857", "fromPort": "output", "toPort": "input" }, { "from": "reset_column_1641378677857", "to": "load_label_1641378693437", "fromPort": "output", "toPort": "input" }, { "from": "reset_column_1641378677857", "to": "load_label_1641379037544", "fromPort": "output", "toPort": "input" }, { "from": "reset_column_1641378677857", "to": "load_label_1641379268973", "fromPort": "output", "toPort": "input" }, { "from": "reset_column_1641378677857", "to": "load_label_1641435899933", "fromPort": "output", "toPort": "input" } ], "frontendInfo": null }, "outputNode": { "key": "load_label_1641435899933" }, "taskId": 4388, "taskType": 0, "ownerEmailPrefix": "tangying.ty", "taskTime": null, "frequency": null, "paramConf": { "engineParams": [ { "key": "spark.driver.extraJavaOptions", "value": "-Ddb2.jcc.charsetDecoderEncoder=3" }, { "key": "spark.executor.extraJavaOptions", "value": "-Ddb2.jcc.charsetDecoderEncoder=3" } ], "nonEngineParams": [] }, "appId": null }, "scheduleConf": { "scheduleType": 1, "scheduleTimeType": 0, "scheduleFrequency": "daily", "scheduleTimeSettings": [ "00:01" ], "interval": null, "intervalUnit": null, "dependencyNodes": [ { "nodeKey": "load_label_1641378693437", "nodeName": "输出标签_1", "dependencies": [ { "dbName": "cdp", "tableName": "user_cdp", "dataType": "hive", "subTasks": [ { "id": 105168936, "nodeKey": null, "nodeName": null, "taskId": null, "taskName": "HPSensor_cdp.user_cdp_#1", "source": "raw_data", "frequency": null, "scheduleConf": { "scheduleType": 1, "scheduleTimeType": 0, "scheduleFrequency": "daily", "scheduleTimeSettings": [], "interval": null, "intervalUnit": 0 }, "offsetInfo": { "offsets": [ 0 ], "offsetType": "set", "offsetFrequency": "daily" }, "mtime": null, "dependencyStatus": 1, "dependencyType": 1, "recommendTaskInfo": { "projectId": 5, "databaseName": "cdp", "tableName": "user_cdp", "frequency": "daily", "path": "p_date=2021-09-01/", "type": "hive_partition-sensor", "taskPartitions": [ { "value": "2021-09-01", "key": "p_date" } ] } } ], "inputNodes": [ { "nodeKey": "Read_user_cdp_1641378601419", "nodeName": "user_cdp" } ], "readPartitionInfo": { "logic": true, "type": null, "operator": null, "operand": null, "children": [ { "logic": null, "type": "string", "operator": "=", "operand": [ { "name": "p_date", "isAutoDataType": false, "distinct": false }, { "type": "string", "dataType": "string", "value": "2021-09-01", "isAutoDataType": false, "distinct": false } ], "children": [] } ] } } ], "nodeDepStatus": 1, "dependencyMethod": 0, "filterUnCompleteSensor": null, "isSelfDepend": false, "earliestBackTime": null }, { "nodeKey": "load_label_1641379037544", "nodeName": "输出标签_2", "dependencies": [ { "dbName": "cdp", "tableName": "user_cdp", "dataType": "hive", "subTasks": [ { "id": 105168936, "nodeKey": null, "nodeName": null, "taskId": null, "taskName": "HPSensor_cdp.user_cdp_#1", "source": "raw_data", "frequency": null, "scheduleConf": { "scheduleType": 1, "scheduleTimeType": 0, "scheduleFrequency": "daily", "scheduleTimeSettings": [], "interval": null, "intervalUnit": 0 }, "offsetInfo": { "offsets": [ 0 ], "offsetType": "set", "offsetFrequency": "daily" }, "mtime": null, "dependencyStatus": 1, "dependencyType": 1, "recommendTaskInfo": { "projectId": 5, "databaseName": "cdp", "tableName": "user_cdp", "frequency": "daily", "path": "p_date=2021-09-01/", "type": "hive_partition-sensor", "taskPartitions": [ { "value": "2021-09-01", "key": "p_date" } ] } } ], "inputNodes": [ { "nodeKey": "Read_user_cdp_1641378601419", "nodeName": "user_cdp" } ], "readPartitionInfo": { "logic": true, "type": null, "operator": null, "operand": null, "children": [ { "logic": null, "type": "string", "operator": "=", "operand": [ { "name": "p_date", "isAutoDataType": false, "distinct": false }, { "type": "string", "dataType": "string", "value": "2021-09-01", "isAutoDataType": false, "distinct": false } ], "children": [] } ] } } ], "nodeDepStatus": 1, "dependencyMethod": 0, "filterUnCompleteSensor": null, "isSelfDepend": false, "earliestBackTime": null }, { "nodeKey": "load_label_1641379268973", "nodeName": "输出标签_3", "dependencies": [ { "dbName": "cdp", "tableName": "user_cdp", "dataType": "hive", "subTasks": [ { "id": 105168936, "nodeKey": null, "nodeName": null, "taskId": null, "taskName": "HPSensor_cdp.user_cdp_#1", "source": "raw_data", "frequency": null, "scheduleConf": { "scheduleType": 1, "scheduleTimeType": 0, "scheduleFrequency": "daily", "scheduleTimeSettings": [], "interval": null, "intervalUnit": 0 }, "offsetInfo": { "offsets": [ 0 ], "offsetType": "set", "offsetFrequency": "daily" }, "mtime": null, "dependencyStatus": 1, "dependencyType": 1, "recommendTaskInfo": { "projectId": 5, "databaseName": "cdp", "tableName": "user_cdp", "frequency": "daily", "path": "p_date=2021-09-01/", "type": "hive_partition-sensor", "taskPartitions": [ { "value": "2021-09-01", "key": "p_date" } ] } } ], "inputNodes": [ { "nodeKey": "Read_user_cdp_1641378601419", "nodeName": "user_cdp" } ], "readPartitionInfo": { "logic": true, "type": null, "operator": null, "operand": null, "children": [ { "logic": null, "type": "string", "operator": "=", "operand": [ { "name": "p_date", "isAutoDataType": false, "distinct": false }, { "type": "string", "dataType": "string", "value": "2021-09-01", "isAutoDataType": false, "distinct": false } ], "children": [] } ] } } ], "nodeDepStatus": 1, "dependencyMethod": 0, "filterUnCompleteSensor": null, "isSelfDepend": false, "earliestBackTime": null }, { "nodeKey": "load_label_1641435899933", "nodeName": "输出标签_4", "dependencies": [ { "dbName": "cdp", "tableName": "user_cdp", "dataType": "hive", "subTasks": [ { "id": 105168936, "nodeKey": null, "nodeName": null, "taskId": null, "taskName": "HPSensor_cdp.user_cdp_#1", "source": "raw_data", "frequency": null, "scheduleConf": { "scheduleType": 1, "scheduleTimeType": 0, "scheduleFrequency": "daily", "scheduleTimeSettings": [], "interval": null, "intervalUnit": 0 }, "offsetInfo": { "offsets": [ 0 ], "offsetType": "set", "offsetFrequency": "daily" }, "mtime": null, "dependencyStatus": 1, "dependencyType": 1, "recommendTaskInfo": { "projectId": 5, "databaseName": "cdp", "tableName": "user_cdp", "frequency": "daily", "path": "p_date=2021-09-01/", "type": "hive_partition-sensor", "taskPartitions": [ { "value": "2021-09-01", "key": "p_date" } ] } } ], "inputNodes": [ { "nodeKey": "Read_user_cdp_1641378601419", "nodeName": "user_cdp" } ], "readPartitionInfo": { "logic": true, "type": null, "operator": null, "operand": null, "children": [ { "logic": null, "type": "string", "operator": "=", "operand": [ { "name": "p_date", "isAutoDataType": false, "distinct": false }, { "type": "string", "dataType": "string", "value": "2021-09-01", "isAutoDataType": false, "distinct": false } ], "children": [] } ] } } ], "nodeDepStatus": 1, "dependencyMethod": 0, "filterUnCompleteSensor": null, "isSelfDepend": false, "earliestBackTime": null } ], "clusterId": null, "queue": null, "priority": null }, "advancedParamConf": null, "subTaskConf": { "confList": [ { "nodeKey": "load_label_1641378693437", "scheduleConf": { "clusterId": null, "queue": null, "priority": null, "scheduleType": 0, "scheduleTimeType": null, "scheduleFrequency": null, "scheduleTimeSettings": [], "interval": null, "intervalUnit": null, "hasSavePoint": false, "consumerStatus": 0, "isDynamicPartition": false, "retryNum": 1, "retryInterval": 10 }, "advancedParamConf": { "params": [] }, "monitorConf": { "alarmRules": [] } }, { "nodeKey": "load_label_1641379037544", "scheduleConf": { "clusterId": null, "queue": null, "priority": null, "scheduleType": 0, "scheduleTimeType": null, "scheduleFrequency": null, "scheduleTimeSettings": [], "interval": null, "intervalUnit": null, "hasSavePoint": false, "consumerStatus": 0, "isDynamicPartition": false, "retryNum": 1, "retryInterval": 10 }, "advancedParamConf": { "params": [] }, "monitorConf": { "alarmRules": [] } }, { "nodeKey": "load_label_1641379268973", "scheduleConf": { "clusterId": null, "queue": null, "priority": null, "scheduleType": 0, "scheduleTimeType": null, "scheduleFrequency": null, "scheduleTimeSettings": [], "interval": null, "intervalUnit": null, "hasSavePoint": false, "consumerStatus": 0, "isDynamicPartition": false, "retryNum": 1, "retryInterval": 10 }, "advancedParamConf": { "params": [] }, "monitorConf": { "alarmRules": [] } }, { "nodeKey": "load_label_1641435899933", "scheduleConf": { "clusterId": null, "queue": null, "priority": null, "scheduleType": 0, "scheduleTimeType": null, "scheduleFrequency": null, "scheduleTimeSettings": [], "interval": null, "intervalUnit": null, "hasSavePoint": false, "consumerStatus": 0, "isDynamicPartition": false, "retryNum": 1, "retryInterval": 10 }, "advancedParamConf": { "params": [] }, "monitorConf": { "alarmRules": [] } } ] } }, "labelEntityType": null } ``` **返回结果示例** ```Plain Text { "code": "prep/ok", "data": null, "extra_msg": null, "msg": "成功" } ``` # 15. 获取依赖指定表的子任务 **接口说明** 接口说明通过本接口，可以获取依赖某个表的子任务列表。 **请求地址** ```Plain Text GET https://{domain}/aeolus/prep/userOpenAPI/v1/task/scheduleTasksInfoByDbTable ``` **请求参数** | | | | | | | \ |**参数名称** |**类型** |**默认值** |**必填** |**说明** |**示例** | |---|---|---|---|---|---| | | | | | | | \ |dataSourceType |string | |是 | |hive | | | | | | | | \ |dbName |string | |是 | |dw_aeolus | | | | | | | | \ |tableName |string | |是 | |tb_acc0ddaa638ca3b0a74bab211cb7a9f4 | **返回结果示例** ```Plain Text { "code": "prep/ok", "message": "成功", "extraMsg": null, "advice": null, "data": { "dependencies": [ { "taskType": 0, "taskScheduleType": 1, "scheduleTaskId": 106248411, "projectId": 756, "frequency": "daily", "scheduleType": 0, "taskId": 6268, "subTaskId": 4468 } ] } } ``` # 16. 获取依赖指定表列表的子任务列表 **接口说明** 接口说明通过本接口，可以获取某些表的子任务列表 **请求地址** ```Plain Text GET https://{domain}/aeolus/prep/userOpenAPI/v1/task/scheduleTasksInfoListByDbTableList ``` **请求参数** | | | | | | \ |**参数名称** |**类型** |**默认值** |**必填** |**说明** | |---|---|---|---|---| | | | | | | \ |dbTableList |array | |是 |{dataSourceType, dbName, tableName} | **请求参数示例** ```Plain Text { "dbTableList": [{ "dataSourceType": "hive", "dbName": "aaa", "tableName": "event_log_hourly" }] } ``` **返回结果示例** 正确示例： ```Plain Text { "code": "prep/ok", "message": "成功", "extraMsg": null, "advice": null, "data": [ { "dbName": "aaa", "tableName": "event_log_hourly", "dataSourceType": "hive", "dependencies": [] } ] } ``` # 17. 通过模板创建任务 **接口说明** 接口说明通过本接口，可以通过模板创建任务。 **请求地址** ```Plain Text POST https://{domain}/aeolus/prep/userOpenAPI/v1/task/createByTemplate ``` **请求参数** | | | | | | \ |**参数名称** |**类型** |**默认值** |**必填** |**说明** | |---|---|---|---|---| | | | | | | \ |id |long | |是 | | | | | | | | \ |taskId |long | |否 | | | | | | | | \ |doradoIdList |array | |否 |数组元素是long | | | | | | | \ |appId; |long | |是 | | | | | | | | \ |name |string | |是 | | | | | | | | \ |ownerEmailPrefix |string | |是 | | | | | | | | \ |status |int | |否 | | | | | | | | \ |taskType |int |1 |否 | | | | | | | | \ |taskSource |int | |否 | | | | | | | | \ |region |string | |否 | | | | | | | | \ |params |map | |是 |map | | | | | | | \ |needRun |boolean |true |否 | | **请求参数示例** ```Plain Text { "id": 9, "taskId": 0, "appId": 555327, "region": "cn", "name": "OfflineTaskByTemplate_07136", "ownerEmailPrefix": "caokai.1109", "taskType": 0, "needRun": false, "params": { "redis.psm": "vpc.tendis.cluster", "ch.clusterName": "rangers", "ch.sql": "select toInt32(1) as `id`, toFloat32('\''1.1'\''), toFloat64('\''1.1'\''), toDate('\''2022-03-03'\'')", "redis.key.prefix": "caokai_test", "redis.ttl": "0" } } ``` **返回结果示例** ```Plain Text { "code": "prep/ok", "data": null, "extra_msg": null, "msg": "成功" } ``` # 18. 根据Prep数据类型批量获取引擎数据类型 **接口说明** 接口说明通过本接口，可以获取引擎数据类型 **请求地址** ```Plain Text GET https://{domain}/aeolus/prep/userOpenAPI/v1/task/engineTypeFromPrepTypeBatch ``` **请求参数** | | | | | | | \ |**参数名称** |**类型** |**默认值** |**必填** |**说明** |**示例** | |---|---|---|---|---|---| | | | | | | | \ |dataSourceType |string | |是 | |hive | | | | | | | | \ |typeList |string | |是 | |long;short | **返回结果示例** ```Plain Text { "code": "prep/ok", "data": null, "extra_msg": null, "msg": "成功" } ``` # 19. 根据引擎数据类型批量获取Prep数据类型 **接口说明** 接口说明通过本接口，可以获取Prep数据类型。 **请求地址** ```Plain Text GET https://{domain}/aeolus/prep/userOpenAPI/v1/task/prepTypeFromEngineTypeBatch ``` **请求参数** | | | | | | | \ |**参数名称** |**类型** |**默认值** |**必填** |**说明** |**示例** | |---|---|---|---|---|---| | | | | | | | \ |dataSourceType |string | |是 | |hive | | | | | | | | \ |typeList |string | |是 | |bigint;smallint | **返回结果示例** ```Plain Text { "code": "prep/ok", "data": null, "extra_msg": null, "msg": "成功" } ``` # 20. 批量获取任务基本信息 **接口说明** 接口说明通过本接口，可以批量获取任务的基本信息 **请求地址** ```Plain Text POST https://{domain}/aeolus/prep/userOpenAPI/v1/task/taskBasicInfoBatch ``` **请求参数** param： | | | | | | | \ |**参数名称** |**类型** |**默认值** |**必填** |**说明** |**示例** | |---|---|---|---|---|---| | | | | | | | \ |skipIfNotFound |string |false |否 | |true | body： | | | | | | | \ |**参数名称** |**类型** |**默认值** |**必填** |**说明** |**示例** | |---|---|---|---|---|---| | | | | | | | \ |taskIds |array | |是 | |[6087, 12345678] | **返回结果示例** ```Plain Text { "code": "prep/ok", "data": null, "extra_msg": null, "msg": "成功" } ``` # 21. 获取Prep数据类型列表 **接口说明** 本接口可以获取Prep中不同数据源的数据类型列表。 **请求地址** ```Plain Text GET https://{domain}/aeolus/prep/userOpenAPI/v1/task/prepTypeList ``` **请求参数** | | | | | | | \ |**参数名称** |**类型** |**默认值** |**必填** |**说明** |**示例** | |---|---|---|---|---|---| | | | | | | | \ |dataSourceType |string | |否 | |hive | **返回结果示例** ```Plain Text { "code": "prep/ok", "message": "成功", "extraMsg": null, "advice": null, "data": [ "string", "int", "double", "date", "timestamp", "long", "short", "float", "decimal", "binary", "boolean", "byte" ] } ``` # 22. 获取子任务的执行DAG **接口说明** 本接口可以获取子任务的执行DAG。 **请求地址** ```Plain Text GET https://{domain}/aeolus/prep/userOpenAPI/v1/task/taskDagInfoList ``` **请求参数** | | | | | | | \ |**参数名称** |**类型** |**默认值** |**必填** |**说明** |**示例** | |---|---|---|---|---|---| | | | | | | | \ |taskId |int | |是 | |6447 | | | | | | | | \ |taskTime |string | |是 | | | | | | | | | | \ |relation |string | |是 | | | | | | | | | | \ |depth |int | |是 | | | | | | | | | | \ |scheduleTaskId |int | |否 | | | **返回结果示例** ```Plain Text { "code": "prep/ok", "message": "成功", "extraMsg": null, "advice": null, "data": null } ``` # 23. 获取流任务的列表 **接口说明** 本接口可以获取Prep中流任务列表。 **请求地址** ```Plain Text GET https://{domain}/aeolus/prep/userOpenAPI/v1/streamTask/allListByAppId ``` **请求参数** | | | | | | | \ |**参数名称** |**类型** |**默认值** |**必填** |**说明** |**示例** | |---|---|---|---|---|---| | | | | | | | \ |appId |int | |是 | |555327 | | | | | | | | \ |type |string | |是 | |kafka | **返回结果示例** ```Plain Text { "code": "prep/ok", "message": "成功", "extraMsg": null, "advice": null, "data": null } ``` # 24. 获取节点Schema信息 **接口说明** 本接口可以获取节点Schema信息。 **请求地址** ```Plain Text POST https://{domain}/aeolus/prep/userOpenAPI/v1/task/resultSchema ``` **请求参数** | | | | | | \ |**参数名称** |**类型** |**默认值** |**必填** |**说明** | |---|---|---|---|---| | | | | | | \ |portName |string | |否 | | **请求体** | | | | | | \ |**参数名称** |**类型** |**默认值** |**必填** |**说明** | |---|---|---|---|---| | | | | | | \ |dagConf |object | |是 | | | | | | | | \ |ownerEmailPrefix |string | |是 | | **请求参数示例** ```Plain Text { "dagConf": { "dag": { "nodes": [ { "key": "Read_524get_test_1655227481185", "name": "524get_test", "type": "Read", "dataType": "restapi", "nodeStatus": "DEFAULT", "connection": { "dataSourceId": 185, "prepDataSetId": null, "datasetName": "", "fileId": null, "contentType": null, "path": null, "host": null, "port": null, "user": null, "password": null, "catalogName": null, "dbName": "524get_test", "driverName": null, "tableName": "524get_test", "sql": null, "oriSql": null, "dataSetIdList": null, "partitions": [], "encryptMethod": 0, "additionalParamsStr": null, "jdbcConnectionString": null, "shardNum": 0, "chPartitionType": null, "clusterName": "cn", "shardColumn": null, "bootstrapServers": null, "topicName": null, "groupId": null, "checkpointLocation": null, "displayTableName": "524get_test" }, "sampleJson": null, "isDataSetColumn": null, "outputColumns": [ { "name": "city", "type": "string", "originType": "string", "is_support": 1, "isSelect": true }, { "name": "weather", "type": "string", "originType": "string", "is_support": 1, "isSelect": true } ], "operators": { "filters": {} }, "params": { "extractType": "{\"key\":\"full\"}", "readNum": "{\"key\":\"sample\",\"value\":\"200\"}" }, "advanceSettings": [], "frontendInfo": { "layout": null, "position": { "x": 100, "y": 100 } } } ], "flows": [] }, "outputNode": { "key": "Read_524get_test_1655227481185" } }, "ownerEmailPrefix": "guohaishuai" } ``` **返回结果示例** ```Plain Text { "code": "prep/ok", "message": "成功", "extraMsg": null, "advice": null, "data": null } ``` # 25. 获取任务所用的所有读算子信息 **接口说明** 本接口可以获取节点Schema信息。 **请求地址** ```Plain Text GET https://{domain}/aeolus/prep/userOpenAPI/v1/task/allInputNodesInfo ``` **请求参数** | | | | | | \ |**参数名称** |**类型** |**默认值** |**必填** |**说明** | |---|---|---|---|---| | | | | | | \ |taskId |integer | |否 | | **请求体** | | | | | | \ |**参数名称** |**类型** |**默认值** |**必填** |**说明** | |---|---|---|---|---| **请求参数示例** ```Plain Text aeolus/prep/userOpenAPI/v1/task/allInputNodesInfo?taskId=1 ``` **返回结果示例** 读节点(或称上游数据源)可以分为三类，即数据集读节点，正常数据源读节点，自定义sql数据源读节点，每种数据源对应的schema信息也是不同的，下面的例子可以很好地展示 ```Plain Text { "code": "prep/ok", "message": "成功", "extraMsg": null, "advice": null, "data": [ { "nodeKey": "nodeKey", "nodeType": "nodeType", "displayTableName": "Sheet1_极简1", "dataSourceId": 28355, "clusterName": "cn", "dbName": "aeolus_excel_upload_aeolus_toy", "dataSourceType": "ch_excel", "tableName": "table_475d4f5e_2486_42af_b8db_503b8fde711c" }, { "nodeKey": "nodeKey", "nodeType": "nodeType", "dataSetId": 33906, "dataSetName": "需求数据集-1-最后自测", "dataSourceType": "click_house", "abiDataSetId": 226093 }, { "nodeKey": "nodeKey", "nodeType": "nodeType", "dataSourceType": "click_house", "sql": "select `tag_value_bigint`, `tag_value_array_string`, `original_value`, `tag_value_date`, `tag_value_datetime`, `compute_time`, `tag_id`, `p_date`, `tag_value_double`, `tag_value_string`, `tag_value_type`, `id` from `aeolus_data_db_aeolus_test_202101`.`rjhtest_2`" } ] } ```

客户数据平台（私有化）