メインコンテンツへスキップ

​
エンドポイント

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

​
説明

ワークフローの現在の制御状態を返します：一時停止中、キャンセルされたか、アクションをトリガーした人とその時刻に関するメタデータ。 これは以下に役立ちます：
  • 一時停止 / 再開ボタンの状態を表示するUIの構築
  • 他のシステムを調整するためのバックエンドサービスからのポーリング

​
認証

必要: はい ヘッダーにAPIキーを含めてください： 
X-API-Key: sk_test_123456

​
リクエスト

​
ヘッダー

ヘッダー必要説明
X-API-KeyはいAPI認証キー
traceparentいいえW3Cトレースコンテキスト

​
パスパラメータ

パラメータタイプ必要説明
idstringはいタスクID（Temporalワークフロー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" }