任务(Task)接口
更新时间:2025-04-18
任务详情
请求结构
- method:POST
- URL:/api/logic/oos/v2/task?{Query参数}namespace=${ns}&dagId=${dagId}&taskId=${taskId}&ignoreChildren
请求参数
名称 | 类型 | 描述 | 是否必须 | 参数位置 |
---|---|---|---|---|
dagId | String | 执行(Execution)ID | 是 | Query参数 |
taskId | String | 任务(Task)ID | 是 | Query参数 |
namespace | String | 名称空间,如果用户未使用自定义名称空间,可以不传此字段,默认为“default”, | 否 | Query参数 |
ignoreChildren | boolean | 是否忽略子执行,默认为“false”,不忽略子执行, | 否 | Query参数 |
请求示例1
JSON
1GET /api/logic/oos/v2/task?namesapce=${ns}&dagId=${dagId}&taskId=${taskId}&ignoreChildren=false
响应示例
字段详见Task
JSON
1{
2 "success": true,
3 "msg": "", // 若失败,返回失败原因
4 "result": {
5 // 用户ID
6 "userId": "******",
7
8 // 当前任务id,全局唯一
9 "id": "t-v9ZgQH******",
10
11 // 版本号,当需要更改Task时,需要上传该版本号
12 "revision": 10,
13
14 // 当前Task所属执行id
15 "execution": {
16 "id": "d-nUAtn3******",
17 },
18 // 当前Task执行对应的Operator
19 "operator": {
20 "name": "stopFlow", // 节点名称
21 "description": "BVS摘流", // 节点描述
22 }
23 //其余字段参考附录中的Task
24 }
25}
查询任务子执行列表
请求结构
- method:POST
- URL:/api/logic/oos/v2/task/children/list
请求参数
名称 | 类型 | 描述 | 是否必须 | 参数位置 |
---|---|---|---|---|
executionId | String | 执行(Execution)ID | 是 | RequestBody参数 |
taskId | String | 任务(Task)ID | 是 | RequestBody参数 |
namespace | String | 名称空间,如果用户未使用自定义名称空间,可以不传此字段,默认为“default”, | 否 | RequestBody参数 |
states | List<String> | 按state进行筛选,选填,若未设置,返回所有状态的子执行 | 否 | RequestBody参数 |
pageNo | int | 页数,从1开始计数 | 是 | RequestBody参数 |
pageSize | int | 每页展示数量,最大值:100,最小值:1 | 是 | RequestBody参数 |
请求示例
JSON
1POST /api/logic/oos/v2/task/children/list
2{
3 "namespace": "default",
4 "executionId": "d-98d95c3******",
5 "taskId": "t-42a95f55c39******",
6 "states": ["RUNNING", "SUCCESS"],
7 "pageNo": 1,
8 "pageSize": 10
9}
响应示例
JSON
1{
2 "success": true,
3 "msg": "", // 若失败,返回失败原因
4 "result":{
5 // 子执行总数量
6 "total": 63
7 "pageNo": 1, // 第几页,从1开始计数,必填
8 "pageSize": 10, // 每页展示数量,必填,最大值:100
9 "orderBy" : "";
10 "order": "";
11 // 子执行分页列表
12 "children": [
13 {
14 // 当前子执行对应的loops序号
15 "loopIndex": 0,
16 "createdTimestamp": 1700468603936, // 创建时间戳,Unix时间戳,单位:毫秒
17 "updatedTimestamp": 1700468605197, // 最近更新时间戳,Unix时间戳,单位:毫秒
18 "finishedTimestamp": 1700468605197, // 执行结束时间戳,Unix时间戳,单位:毫秒,若未结束,该字段填0
19
20 // 当前子执行的状态,可选值
21 // PENDING - 等待中
22 // RUNNING - 运行中
23 // SUCCESS - 运行成功
24 // FAILED - 运行失败
25 // UP_FOR_RETRY - 等待重试中
26 "state": "SUCCESS",
27
28 // 子执行虚机参数
29 "properties": {
30 "__worker__": {
31 "instanceId": "i-1e******",
32 "internalIp": "192.168.*.*",
33 "name": "****"
34 }
35 },
36 // 当前子执行的执行实例列表。当发生重试时,会产生多个执行实例
37 "executions": [
38 {
39 "id": "d-8763f77******",
40 "createdTimestamp": 1659534994121,
41 "revision": 10,
42 }
43 ]
44 }
45 ...
46 ]
47 }
48 }
替换参数重新执行Task
请求结构
- method:POST
- URL:/api/logic/oos/v2/task/clear
请求参数
名称 | 类型 | 描述 | 是否必须 | 参数位置 |
---|---|---|---|---|
executionId | String | 执行(Execution)ID | 是 | RequestBody参数 |
taskId | String | 任务(Task)ID | 是 | RequestBody参数 |
operator | String | 算子名称 | 是 | RequestBody参数 |
namespace | String | 名称空间,如果用户未使用自定义名称空间,可以不传此字段,默认为“default”, | 否 | RequestBody参数 |
clearDownstreams | boolean | 是否一并重置下游节点 | 否 | RequestBody参数 |
properties | Map<String, Object> | 重新执行task的参数 | 否 | RequestBody参数 |
请求示例
JSON
1POST /api/logic/oos/v2/task/clear
2{
3 "namespace": "default",
4 "taskId": "t-42a95f55******",
5 "executionId": "d-f3b7c******",
6 "operator": "BCE::Agent::ExecuteShell",
7 "clearDownstreams": true,
8 "properties": {
9 "content": "echo hello",
10 "instances": [
11 {
12 "instanceId": "i-Ut******",
13 "internalIp": "192.168.*.*",
14 "name": "***"
15 }
16 ],
17 "user": "root",
18 "workDir": "/"
19 }
20}
响应示例
JSON
1{
2 "success": true,
3 "msg": "", // 若失败,返回失败原因
4}