Skip to main content

取消当前执行

千问办公企业旗舰版开发者文档:取消当前执行。

认证方式见APP开发者文档 → 认证接入。
  • 模块:会话服务(session)
  • 接口:POST/api/openapi/app/v1/sessions/{session_id}/cancel

请求参数

参数位置类型必填说明
session_idpathstring是创建会话接口返回的会话 ID。

响应

HTTP说明
200未执行取消操作。status=noop;reason 为 no_active_turn(无运行中回合)或 not_started(运行环境仍在准备)。这不是错误,而是当前没有可中断的回合。
202已接收请求
default错误响应。按 code 判断具体错误,不能仅依赖 HTTP 状态码,多种错误可能共用状态码。
媒体类型:application/json。

响应200 CancelResponse

字段类型必填约束契约说明
command_idstring否—取消命令 ID,仅实际发送取消时返回。以 commandId 交给 Agent,可用于日志排查;事件流不回显此 ID。
reasonstring否—未取消的原因,仅 status=noop 时返回:no_active_turn 表示无运行中回合,not_started 表示运行环境仍在准备。
statusstring是—cancelling 表示已向运行中的回合发送取消请求,不代表已经停止;继续查询会话状态。noop 表示没有可取消的回合,原因见 reason。
turn_idstring否—正在取消的回合;没有运行中回合时为 null 或省略。
媒体类型:application/json。

响应202 CancelResponse

字段类型必填约束契约说明
command_idstring否—取消命令 ID,仅实际发送取消时返回。以 commandId 交给 Agent,可用于日志排查;事件流不回显此 ID。
reasonstring否—未取消的原因,仅 status=noop 时返回:no_active_turn 表示无运行中回合,not_started 表示运行环境仍在准备。
statusstring是—cancelling 表示已向运行中的回合发送取消请求,不代表已经停止;继续查询会话状态。noop 表示没有可取消的回合,原因见 reason。
turn_idstring否—正在取消的回合;没有运行中回合时为 null 或省略。

使用说明

创建会话绑定当前IAM用户;资源读取与变更按用户归属校验。写入发生超时或响应丢失时,不应假定服务端未接纳并盲目重复请求。