pending または running の Dream をキャンセルします。
POST /api/v1/cloud/dreams/{id}/cancel
指定された Dream をキャンセルします。ステータスが pending または running の Dream のみキャンセル可能です。すでにキャンセル済みの Dream に対する cancel 呼び出しは冪等です。更新された Dream オブジェクト を返します。
ヘッダー
| ヘッダー | 必須 | 説明 |
|---|---|---|
Authorization | はい | Bearer <PAT または SAT> |
パスパラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
id | string | Dream ID(drm_ プレフィックス) |
リクエスト例
レスポンス例
HTTP 200 OK
エラー
| HTTP | 種別 | トリガー |
|---|---|---|
| 400 | invalid_request_error | Dream が completed または failed(終了状態、キャンセル不可)。canceled は冪等で 200 を返す |
| 401 | authentication_error | 認証トークンが欠落または無効 |
| 404 | not_found_error | Dream が存在しない |