エンドポイント
説明
キューにあるか実行中のタスクをキャンセルします。キャンセルが処理のために受け入れられた場合は202 Accepted を返します。タスクがすでに最終状態に達している場合は 409 Conflict を返します。
認証
必要: はい ヘッダーにAPIキーを含めてください:リクエスト
ヘッダー
| ヘッダー | 必要 | 説明 |
|---|---|---|
X-API-Key | はい | API認証キー |
Content-Type | いいえ | 本文が提供される場合は application/json |
traceparent | いいえ | W3Cトレースコンテキスト |
パスパラメータ
| パラメータ | タイプ | 必要 | 説明 |
|---|---|---|---|
id | string | はい | タスクID(TemporalワークフローID) |
ボディパラメータ
| パラメータ | タイプ | 必要 | 説明 |
|---|---|---|---|
reason | string | いいえ | 任意の人間が読める理由 |
リクエストボディスキーマ
レスポンス
202 Accepted
409 Conflict
404 Not Found
401 / 403
例
curl
Python (httpx)
JavaScript (axios)
注意事項
- 冪等性: 繰り返し呼び出すと、現在の状態に応じて
202または409が返されます。 - キャンセルは子ワークフローに伝播されます(
REQUEST_CANCELを介して優雅に)。