実行待ちまたは実行中の Dream をキャンセルします。
POST /api/v1/forward/dreams/{id}/cancel
pending または running 状態の Dream のみキャンセルできます。キャンセル済みの Dream に対する再呼び出しでは、冪等に現在のオブジェクトを返します。
ヘッダー
| Header | 必須 | 説明 |
|---|---|---|
Authorization | はい | Bearer <PAT or admin SAT>。 |
パスパラメーター
| パラメーター | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | はい | drm_ プレフィックスを持つ Dream ID。 |
リクエスト例
レスポンス例
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 の管理権限がありません。この API は Identity SAT に対応していません。 |
404 | not_found_error | Dream が存在しないか、呼び出し元から参照できません。error.code は dream_not_found です。 |
429 | rate_limit_error | リクエスト頻度の上限に達しています。 |
500/502/503 | api_error | サービスまたは内部の依存サービスが一時的に利用できません。 |

