跳至文檔內容
POSTBearer 權杖

管理快照

/api/v1/servers/:id/snapshots/action

建立、重新命名、刪除或還原所屬伺服器的快照。回應描述的是操作,而非快照本身。

呼叫前請注意

刪除與還原須提供 confirm=true。還原會取代伺服器資料。相同 requestKey 會回傳原操作,請以其 taskKey 查詢,不要盲目重試。

API 欄位名稱、型別與程式碼在所有語言中保持原樣。

請求範例

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

僅提供範例,此頁不會發送 API 請求。

參數

id路徑 · 必填

string

資源 ID:24 個十六進位字元。請使用對應列表端點回傳的平台 ID,而非供應商的執行個體 ID。

actionJSON 請求主體 · 必填

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

快照操作。

requestKeyJSON 請求主體 · 必填

string

8–100 個字元,僅限 A–Z、a–z、0–9、底線或連字號。重試同一操作時,請沿用相同的鍵值與完全相同的輸入。

snapshotIdJSON 請求主體 · 選填

string

供應商快照 ID,1–80 個字元。update、delete、restore 均須提供。

nameJSON 請求主體 · 選填

string

去除頭尾空白後的名稱,1–30 個字元。create 與 update 均須提供。

descriptionJSON 請求主體 · 選填

string

去除頭尾空白後的說明,最多 255 個字元。

confirmJSON 請求主體 · 選填

boolean

明確確認操作影響後才設為 true。伺服器強制斷電 stop、終止、重裝、改密及快照刪除/還原操作必填。

回應

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

平台端完成時間(若有)。