取消一个等待执行或正在执行的 Dream。
POST /api/v1/forward/dreams/{id}/cancel
只有 pending 或 running 状态的 Dream 可以取消。已取消的 Dream 再次调用此接口会幂等返回当前对象。
请求头
| Header | 是否必填 | 说明 |
|---|---|---|
Authorization | 是 | Bearer <PAT 或管理员 SAT>。 |
路径参数
| 参数 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
id | string | 是 | Dream ID,前缀为 drm_。 |
示例请求
示例响应
HTTP 200 OK
响应字段
| 字段 | 类型 | 说明 |
|---|---|---|
| 返回值 | object | 取消后的 Dream 对象,status 为 canceled。 |
错误
| HTTP | Type | 触发条件 |
|---|---|---|
400 | invalid_request_error | id 无效、请求体不为空,或者 Dream 已为不可取消的终态;error.code 可能为 invalid_dream_id、invalid_request_body 或 dream_not_cancelable。 |
401 | authentication_error | 认证信息缺失、无效或已过期。 |
403 | permission_error | 当前令牌不能管理 Dream;Identity SAT 不支持此接口。 |
404 | not_found_error | Dream 不存在或当前调用方不可见;error.code 为 dream_not_found。 |
429 | rate_limit_error | 请求频率达到限制。 |
500/502/503 | api_error | 服务或内部依赖暂时不可用。 |

