跳转到主要内容

接口

GET http://localhost:8080/api/v1/tasks/{id}/control-state

描述

返回工作流当前的控制状态:是否被暂停、是否被取消,以及谁在什么时候触发的操作等元数据。 常见用途:
  • 在前端构建“暂停 / 恢复”按钮状态
  • 后端轮询协调其他系统的行为

认证

必需:是 在请求头中携带 API Key:
X-API-Key: sk_test_123456

请求

请求头

Header必需说明
X-API-KeyAPI 鉴权 Key
traceparentW3C Trace 上下文

路径参数

参数类型必需说明
idstring任务 ID(Temporal workflow ID)

响应

200 OK

{
  "is_paused": true,
  "is_cancelled": false,
  "paused_at": "2025-10-29T06:00:01Z",
  "pause_reason": "User requested pause",
  "paused_by": "user-123",
  "cancel_reason": "",
  "cancelled_by": ""
}
说明:
  • 如果从未暂停过,paused_at 为空字符串。
  • is_cancelled 反映的是控制信号层面的取消状态,而不仅仅是 Temporal 终止状态。

404 Not Found

{ "error": "Task not found" }

401 / 403

{ "error": "Unauthorized" }
{ "error": "Forbidden" }