跳至文檔內容
開發者文檔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 個十六進位字元。請使用對應列表端點回傳的平台 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

原操作人帳號編號;歷史缺失為null。目前讀者須為同一固定團隊的有效成員。