跳到主要内容
版本:5.9.0

使用api接口取消异常任务

背景

       管理员设置--任务管理页面,管理员可以手动取消大部分类型的任务,但是部分类型任务没有“取消”按钮(已在优化计划中),例如文件导入和导出、数据集预览、Webservice、账户数据集更新、增强分析更新。如果碰到这类任务堵塞导致的系统异常,管理员用户可以暂时使用接口来取消异常任务。

实现方法

1. 获取异常任务 taskID和账户token。

       使用管理员账号登录BI,进入“任务管理”,按 F12,或者右键点击页面选择“检查”打开开发者工具。BI里筛选任务类型和时间范围,从开发者工具里「网络」--「预览」界面找到要取消的任务的 taskID;从「标头」界面找到账户 token 信息,取uIdToken= 后面的长字符串,到第一个分号;为止。示例如下:

image.png

注意: taskID 和账户 token 都可以使用 Postman 调用接口获取(本文暂不做介绍),但紧急情况下使用开发者工具获取信息速度更快、效率更高。

2. 使用Postman,调用接口删除任务。

请求方式:Post

请求地址:$home_url/api/task/{taskId}/cancel

参数说明:

NameLocation类型含义是否必填备注
taskIdURLString任务ID从开发者工具获取
tokenHeadersString账户同步令牌从开发者工具或者调用接口 $home_url/public-api/sign-in获取

示例:

image.png