POST https://ark.cn-beijing.volces.com/api/v3/sessions/{session_id}/tasks/{task_id}/cancel
请求取消指定后台工具任务。
接口成功返回只表示取消请求已处理，不表示任务一定已经停止。
仅当 state 为 cancelled 时，任务才已停止。state 为 queued 或 running 时，请结合 message 判断，并继续使用 查询会话任务 查询状态。
鉴权#
本接口支持鉴权方式如下，详情请参见 Base URL 及鉴权。
- API Key 鉴权，请在 API Key 管理 页面，获取长效 API Key。
请求参数#
Path 参数#
session_id string 必选 | 会话 ID
任务所属的会话 ID，格式为 sesn- 开头的字符串。
task_id string 必选 | 任务 ID
要取消的后台工具任务 ID，格式为 task- 开头的字符串。可从工具调用返回或任务列表响应的 task_id 字段获得。
响应参数#
state string | 任务状态
取消请求处理后的任务状态：
cancelled：任务已取消，不会继续执行。queued：取消请求已受理但任务状态尚未更新，或者任务仍在等待执行。请继续查询任务状态。running：取消请求已受理但状态尚未刷新，或当前执行阶段无法取消。请结合message判断，并继续查询任务状态。- 其他结束状态：任务在取消请求处理前已经结束。
message string | 取消结果说明
取消请求未被接受时的补充说明。取消请求已受理、任务已取消或任务此前已经结束时，不返回该字段。