本文へ
ドキュメントAPI リファレンススナップショット要求の後処理
POSTBearer トークン

スナップショット要求の後処理

/api/v1/servers/:id/snapshots/recover

現在の組織で元のメンバーが送信したスナップショット要求を再確認します。保存済みの受付記録に基づくローカルの後処理だけを行い、元のタスク状態を返します。

呼び出す前に

元の action と requestKey を使用してください。新しい要求の作成やプロバイダーへの呼び出しは行いません。後処理には succeeded の記録、有効な finishedAt、保存済みの応答オブジェクトが必要で、プロバイダーのタスク ID がないことが条件です。元の記録がなければ 409 を返し、証拠が不十分な状態を成功に変更しません。pending と taskStatus も確認してください。state=succeeded だけではプロバイダー側の完了を意味しません。タスクの GET は読み取り専用です。

API のフィールド名、型、コードはすべての言語で共通です。

リクエスト例

cURL
curl "https://tovahub.com/api/v1/servers/507f1f77bcf86cd799439012/snapshots/recover" -X POST \
  -H "Authorization: Bearer $TOVAHUB_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{
  "action": "create",
  "requestKey": "<ORIGINAL_REQUEST_KEY>"
}'

表示のみ。このページから API リクエストは送信されません。

レスポンス例
JSON
{
  "taskKey": "server:507f1f77bcf86cd799439012:snapshot_create:original_request_001",
  "action": "snapshot_create",
  "state": "succeeded",
  "pending": false,
  "localFinishPending": false,
  "taskId": null,
  "taskStatus": null,
  "error": null,
  "createdAt": "2026-11-07T12:00:00.000Z",
  "finishedAt": "2026-11-07T12:00:01.000Z",
  "actorUserId": "507f1f77bcf86cd799439013"
}

パラメーター

idパス · 必須

string

リソース ID。24 桁の16進数文字列です。対応する一覧エンドポイントが返すプラットフォーム ID を使用し、プロバイダーのインスタンス ID は使用しないでください。

actionJSON ボディ · 必須

"create" | "update" | "delete" | "restore"

元のスナップショット操作。既存の snapshot_action 要求と同じ action を使用してください。このエンドポイントは新しい操作を開始しません。

requestKeyJSON ボディ · 必須

string

元の snapshot_action の requestKey。8–100 文字で、A–Z、a–z、0–9、アンダースコア、ハイフンを使用できます。後処理のために新しいキーを生成しないでください。

レスポンス

HTTP ステータス 200 / 202

保存済みのローカル後処理の状態を確認し、元のスナップショットタスクを返します。プロバイダーの呼び出しや新しい要求の作成は行いません。

taskKeystring

固定のプラットフォーム操作キー。

actionstring

記録された操作名。

statestring ('started' | 'succeeded' | 'failed')

プラットフォーム側の操作状態。プロバイダーのタスク状態とは異なります。

pendingboolean

true の場合は HTTP ステータス 202、それ以外は 200。

localFinishPendingboolean

スナップショット要求が succeeded で、保存済みの応答と有効な完了時刻があり、プロバイダーのタスク ID がなく、受付後のローカル処理が未完了の場合は true。元の action と requestKey で recover_snapshot を呼び出してください。タスクの GET は読み取り専用です。

taskIdstring | null

存在する場合、プロバイダーのタスク識別子。

taskStatusstring | null

最後に観測されたプロバイダーのタスク状態。

errorstring | null

存在する場合、機密情報を除去した記録済みエラー。

createdAtstring (ISO 8601)

プラットフォーム側の操作作成日時。

finishedAtstring (ISO 8601) | null

存在する場合、プラットフォーム側の完了日時。

actorUserIdstring (ObjectId) | null

元の操作者のアカウントID。履歴が不完全ならnullです。現在の閲覧者は同じ固定チームの有効メンバーである必要があります。