火山方舟
火山方舟
API参考
请输入
- 文档首页
火山方舟Managed Agents APISessions会话任务取消会话任务
复制全文
下载 pdf取消会话任务
文档反馈
问问助手POST https://ark.cn-beijing.volces.com/api/v3/sessions/{session_id}/tasks/{task_id}/cancel
请求取消指定后台工具任务。接口成功返回只表示取消请求已处理，不表示任务一定已经停止；响应中的 state 表示任务在取消请求处理后的状态，具体如下：
- cancelled：取消请求已生效，任务已取消。
- succeeded：收到取消请求时，任务已经执行成功，因此没有再取消。
- failed：收到取消请求时，任务已经执行失败，因此没有再取消。
- unknown：当前无法确认任务状态，不表示取消成功。建议稍后查询任务状态，或自行查看命令的执行结果。
- queued：任务还在排队。未返回 message，表示取消请求已受理；返回 message，表示取消请求未受理。
- running：任务正在执行。未返回 message，表示取消请求已受理；返回 message，表示当前阶段无法取消。
鉴权
- API Key 鉴权，请在 API Key 管理 页面，获取长效 API Key。
请求参数
Path 参数
session_id string 必选 | 会话 ID
任务所属的会话 ID，格式为 sesn- 开头的字符串。
task_id string 必选 | 任务 ID
要取消的后台工具任务 ID，格式为 task- 开头的字符串。可从工具调用返回或任务列表响应的 task_id 字段获得。
响应参数
state string | 任务状态
任务在取消请求处理后的状态。请根据该字段判断取消是否生效、任务是否已经结束或是否需要继续查询：
- cancelled：取消请求已生效，任务已取消。
- succeeded：收到取消请求时，任务已经执行成功，因此没有再取消。
- failed：收到取消请求时，任务已经执行失败，因此没有再取消。
- unknown：当前无法确认任务状态，不表示取消成功。建议稍后查询任务状态，或自行查看命令的执行结果。
- queued：任务还在排队。未返回 message，表示取消请求已受理；返回 message，表示取消请求未受理，具体原因见 message。请继续查询任务状态。
- running：任务正在执行。未返回 message，表示取消请求已受理；返回 message，表示当前阶段无法取消，具体原因见 message。请继续查询任务状态。
message string | 取消结果说明
取消请求未受理时返回，用于说明原因。
当 state 为 queued 或 running 且返回该字段时，请根据说明处理，并继续查询任务状态。未返回该字段，表示取消请求已受理。
当 state 为 succeeded、failed、cancelled 或 unknown 时，不返回该字段。
取消会话任务
发起调试等同于请求真实调用，可能产生云产品费用，请谨慎操作！
Request
cURL
curl -sS --fail-with-body \
"https://ark.cn-beijing.volces.com/api/v3/sessions/${SESSION_ID}/tasks/${TASK_ID}/cancel" \
-H "Authorization: Bearer $ARK_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'Response
{
"state": "running"
}最近更新时间：2026.10.24 18:27:10
这个页面对您有帮助吗？
有用
有用
无用
无用