端点
描述
取消一个排队或运行中的任务。取消请求被接受时返回202 Accepted。如果任务已进入终态,则返回 409 Conflict。
认证
是否必需:是 请求头:请求
请求头
| 头部 | 必需 | 说明 |
|---|---|---|
X-API-Key | 是 | API 认证密钥 |
Content-Type | 否 | 若带请求体则为 application/json |
traceparent | 否 | W3C Trace 上下文 |
路径参数
| 参数 | 类型 | 必需 | 说明 |
|---|---|---|---|
id | string | 是 | 任务 ID(Temporal Workflow ID) |
请求体参数
| 参数 | 类型 | 必需 | 说明 |
|---|---|---|---|
reason | string | 否 | 可选的人类可读原因 |
请求体示例
响应
202 Accepted
409 Conflict
404 Not Found
401 / 403
示例
curl
Python(httpx)
JavaScript(axios)
备注
- 幂等:重复调用会根据当前状态返回
202或409。 - 取消会向子工作流传播(通过
REQUEST_CANCEL优雅关闭)。