一時停止中の Forward Schedule を再開します。
POST /api/v1/forward/schedules/{schedule_id}/unpause
一時停止中の Schedule を active ステータスに戻します。
Headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer <PAT または SAT> |
Idempotency-Key | No | 安全でないリクエスト向けの任意のべき等キー。 |
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
schedule_id | string | Yes | Forward Schedule ID。 |
Example request
Example response
HTTP 200 OK
Response fields
更新後の Schedule オブジェクトを返します。status=active です。
Errors
| HTTP | Type | Code | 発生条件 |
|---|---|---|---|
| 404 | not_found_error | schedule_not_found | Schedule が存在しないか、現在の owner に属していません。 |
| 409 | invalid_request_error | schedule_archived | Schedule はアーカイブ済みです。 |
| 409 | invalid_request_error | schedule_channel_unavailable | 配信チャネルが存在しない、アクセスできない、または配信設定が利用できません。Schedule の sinks を更新またはクリアしてから再試行してください。 |
| 409 | invalid_request_error | schedule_channel_disabled | 配信チャネルが無効です。チャネルを有効にするか、sinks を更新またはクリアしてから再試行してください。 |
| 409 | invalid_request_error | schedule_channel_binding_changed | チャネルのバインディングが変更され、現在のタスクの要件を満たさなくなりました。sinks を更新またはクリアしてから再試行してください。 |
| 409 | invalid_request_error | schedule_channel_pairing_unavailable | チャネルのペアリングが無効になったか、アクセスできません。再ペアリングして sinks を更新するか、sinks をクリアしてから再試行してください。 |
| 409 | invalid_request_error | schedule_not_active | Identity・Template・Environment の依存先が利用不可、トリガーポリシーが不正、監視ウィンドウ内に将来のトリガー時刻がないなど、その他の再開条件を満たしていません。 |
| 401 | authentication_error | - | PAT または SAT が無効または期限切れです。 |
| 403 | permission_error | identity_mismatch | Identity-bound SAT が、バインドされた Identity 以外の Schedule を要求または操作しています。 |
チャネルが存在しない場合のレスポンス例
HTTP 409 Conflict
{"sinks": []} を渡して配信設定をクリアしてから、再開 API を呼び出してください。クリア後は、そのチャネルを通じてタスクの結果は配信されません。再開操作自体がチャネルを修復または再作成することはありません。
Notes
- 再開しても Schedule Run は直ちには作成されません。
- 再開前に関連する依存先とトリガー設定を検証します。paused 状態は再開できますが、チャネルの無効化などの依存先の問題があると再開できません。
- 再開に失敗した場合、タスクの状態・バージョン・次回トリガー時刻は変更されず、一時停止中のタスクは paused のままです。
- cron / interval タスクでは、まだ有効な将来のトリガー時刻を保持します。未設定または期限切れの場合は、現在のトリガールールと監視ウィンドウに基づいて再計算し、実行されなかった過去のトリガーを補完実行しません。ウィンドウ内に将来のトリガー時刻がない場合は
schedule_not_activeを返します。