任务运行时接口
2.3 任务运行时接口¶
2.3.1 获取任务列表¶
Path： /api-task/tasks/
Method： GET
Headers：Headers
请求参数¶
| 字段名 | 传参格式 | 说明 | 是否必填 | 类型 |
|---|---|---|---|---|
| finished | query | 是否已完成 | Yes | boolean |
| page | query | 页数 | Yes | string |
| pageSize | query | 每页数量 | Yes | string |
| own | query | 是否是自己的任务 | Yes | boolean |
| expandedIds | query | 展开的任务 id | Yes | string[] |
| filters | query | 筛选 | No | string[] |
| searchFilter | query | 搜索 | No | string |
| startTime | query | 开始时间 | No | number |
| endTime | query | 结束时间 | No | number |
返回码¶
| Code | 说明 |
|---|---|
| 200 | Ok |
返回数据¶
| 字段名 | 说明 | 是否必填 | 类型 |
|---|---|---|---|
| list | 任务列表 | Yes | TaskListItem[] |
| page | 页数 | Yes | number |
| total | 总页数 | Yes | number |
| pageSize | 每页数量 | Yes | number |
2.3.2 获取任务详情¶
Path： /api-task/tasks/task
Method： GET
Headers：Headers
请求参数¶
| 字段名 | 传参格式 | 说明 | 是否必填 | 类型 |
|---|---|---|---|---|
| taskIds | query | 展开的任务 id | Yes | string[] |
返回码¶
| Code | 说明 |
|---|---|
| 200 | Ok |
返回数据¶
| 字段名 | 说明 | 是否必填 | 类型 |
|---|---|---|---|
| tasks | 任务列表 | Yes | TaskListItem[] |
TaskListItem¶
| 字段名 | 说明 | 是否必填 | 类型 |
|---|---|---|---|
| id | 任务 id | Yes | string |
| parentId | sessionId | Yes | string | null |
| loading | 是否加载中 | No | boolean |
| userId | 用户名 | No | string |
| userName | 用户姓名 | No | string |
2.3.3 获取任务数量¶
Path： /api-task/tasks/count
Method： GET
Headers：Headers
请求参数¶
| 字段名 | 传参格式 | 说明 | 是否必填 | 类型 |
|---|---|---|---|---|
| own | query | 是否是自己的任务 | Yes | boolean |
返回码¶
| Code | 说明 |
|---|---|
| 200 | Ok |
返回数据¶
| 字段名 | 说明 | 是否必填 | 类型 |
|---|---|---|---|
| count | 任务数量 | Yes | number |
2.3.4 获取任务队列¶
Path： /api-task/tasks/queue
Method： GET
Headers：Headers
请求参数¶
| 字段名 | 传参格式 | 说明 | 是否必填 | 类型 |
|---|---|---|---|---|
| own | query | 是否是自己的任务 | Yes | boolean |
返回码¶
| Code | 说明 |
|---|---|
| 200 | Ok |
返回数据¶
| 字段名 | 说明 | 是否必填 | 类型 |
|---|---|---|---|
| total | 任务总数 | Yes | number |
| running | 运行任务数量 | Yes | number |
| pending | 即将运行任务数量 | Yes | number |
| waiting | 等待任务数量 | Yes | number |
| finished | 结束任务数量 | Yes | number |
| estimatedTaskDuration | 预计任务时间 | Yes | number |
2.3.5 清除全部任务（需要管理员权限）¶
Path： /api-task/tasks/clean
Method： POST
Headers：Headers
请求参数¶
无
返回码¶
| Code | 说明 |
|---|---|
| 202 | Ok |
返回数据¶
无
2.3.6 获取指定 id 的任务¶
Path： /api-task/tasks/:id/task
Method： GET
请求参数¶
| 字段名 | 传参格式 | 说明 | 是否必填 | 类型 |
|---|---|---|---|---|
| id | path | 任务 id | Yes | string |
返回码¶
| Code | 说明 |
|---|---|
| 202 | Ok |
返回数据¶
无
2.3.7 创建任务¶
Path： /api-task/tasks/
Method： POST
Headers：Headers
请求参数¶
| 字段名 | 传参格式 | 说明 | 是否必填 | 类型 | 备注 |
|---|---|---|---|---|---|
| caseIds | body | 案例 id | Yes | string[] | |
| taskName | body | 任务名称 | Yes | string | |
| ~~controllers~~ | body | 任务名称 | Yes | AlgorithmSlot | 移除 |
| ~~overrideVehicleId~~ | body | 覆盖主车id | No | string | 移除 |
| vehicleConfig | body | WorldSim 车辆&算法配置 | Yes | VehicleConfig | 3.7.0 |
| overrideJudgementId | body | 覆盖判定 id | No | string | |
| evaluationPresetId | body | 评价 id | No | string | |
| withEvaluation | body | 是否评价 | No | boolean | |
| notification | body | 运行结果通知配置 | No | Notification | 3.7.0 |
返回码¶
| Code | 说明 |
|---|---|
| 202 | Ok |
返回数据¶
| 字段名 | 说明 | 是否必填 | 类型 |
|---|---|---|---|
| sessionId | sessionId | Yes | string |
| taskIds | 任务 id | Yes | string[] |
2.3.8 回放指定任务¶
Path： /api-task/tasks/:id/replay
Method： POST
Headers：Headers
请求参数¶
| 字段名 | 传参格式 | 说明 | 是否必填 | 类型 |
|---|---|---|---|---|
| id | path | 任务 id | Yes | string |
| RTC | query | 是否 RTC 任务 | No | boolean |
返回码¶
| Code | 说明 |
|---|---|
| 202 | Ok |
返回数据¶
| 字段名 | 说明 | 是否必填 | 类型 |
|---|---|---|---|
| taskId | 任务 id | Yes | string |
2.3.9 查看任务运行可视化¶
Path： /api-task/tasks/:id/observe
Method： POST
Headers：Headers
请求参数¶
| 字段名 | 传参格式 | 说明 | 是否必填 | 类型 |
|---|---|---|---|---|
| id | path | 任务 id | Yes | string |
返回码¶
| Code | 说明 |
|---|---|
| 202 | Ok |
返回数据¶
无
2.3.10 dump 任务¶
Path： /api-task/tasks/:id/dump
Method： POST
Headers：Headers
请求参数¶
| 字段名 | 传参格式 | 说明 | 是否必填 | 类型 |
|---|---|---|---|---|
| id | path | 任务 id | Yes | string |
| vizConfig | body | 每页数量 | Yes | VizConfig |
| outputConfig | body | 每页数量 | Yes | OutputConfig |
返回码¶
| Code | 说明 |
|---|---|
| 202 | Ok |
返回数据¶
无
2.3.11 获取任务数据¶
Path： /api-task/tasks/:id/data
Method： GET
Headers：Headers
请求参数¶
| 字段名 | 传参格式 | 说明 | 是否必填 | 类型 |
|---|---|---|---|---|
| id | path | 任务 id | Yes | string |
返回码¶
| Code | 说明 |
|---|---|
| 200 | Ok |
返回数据¶
| 字段名 | 说明 | 是否必填 | 类型 |
|---|---|---|---|
| success | 是否成功 | Yes | boolean |
2.3.12 创建回放案例¶
Path： /api-task/tasks/convert2case
Method： GET
Headers：Headers
请求参数¶
| 字段名 | 传参格式 | 说明 | 是否必填 | 类型 |
|---|---|---|---|---|
| name | path | 案例名 | Yes | string |
| categoryId | body | 保存目录 id | Yes | string |
| opponent | body | 保存类型，回放案例或标准案例 | No | "record" | "openscenario" |
| ego2npc | body | 选择保存为标准案例时，主车是否转换为对手车 | No | boolean |
| tags | body | 标签 | No | string[] |
| notes | body | 案例备注 | No | string |
返回码¶
| Code | 说明 |
|---|---|
| 200 | Ok |
| 404 | Not Found |
返回数据¶
| 字段名 | 说明 | 是否必填 | 类型 |
|---|---|---|---|
| id | id | Yes | string |
2.3.12 停止任务¶
Path： /api-task/tasks/stop
Method： POST
Headers：Headers
请求参数¶
| 字段名 | 传参格式 | 说明 | 是否必填 | 类型 |
|---|---|---|---|---|
| all | query | 是否停止全部任务 | No | boolean |
| ids | body | 任务 id | Yes | string[] |
| isReplay | body | 是否是回放 | No | boolean |
返回码¶
| Code | 说明 |
|---|---|
| 202 | Ok |
返回数据¶
无
2.3.13 停止回放任务¶
Path： /api-task/tasks/stopReplay
Method： POST
Headers：Headers
请求参数¶
| 字段名 | 传参格式 | 说明 | 是否必填 | 类型 |
|---|---|---|---|---|
| ids | body | 任务 id | Yes | string[] |
返回码¶
| Code | 说明 |
|---|---|
| 202 | Ok |
返回数据¶
无
2.3.14 删除任务¶
Path： /api-task/tasks/delete
Method： POST
Headers：Headers
请求参数¶
| 字段名 | 传参格式 | 说明 | 是否必填 | 类型 |
|---|---|---|---|---|
| taskIds | body | 任务 id | Yes | string[] |
返回码¶
| Code | 说明 |
|---|---|
| 202 | Ok |
返回数据¶
无
2.3.15 获取任务是否结束¶
Path： /api-task/tasks/:id/hasFinished
Method： GET
Headers：Headers
请求参数¶
| 字段名 | 传参格式 | 说明 | 是否必填 | 类型 |
|---|---|---|---|---|
| id | path | 任务 id | Yes | string |
返回码¶
| Code | 说明 |
|---|---|
| 200 | Ok |
返回数据¶
| 字段名 | 说明 | 是否必填 | 类型 |
|---|---|---|---|
| hasFinished | 任务是否结束 | Yes | boolean |