跳至文檔內容
開發者文檔API 參考執行伺服器操作
POSTBearer 權杖

執行伺服器操作

/api/v1/servers/:id/actions

啟動、正常關機(shutdown)、強制斷電(stop)、重新啟動、重設密碼、重灌或終止所屬伺服器服務。

呼叫前請注意

重灌會清除資料。終止服務不會退款,也不會取消供應商合約。破壞性操作須提供 confirm=true;AI 終止或重灌另須提供相符的錢包簽署證明。202 僅代表已受理,不代表完成。結果不明時請以 taskKey 查詢。

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

請求範例

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

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

回應示例
JSON
{
  "ok": true,
  "pending": true,
  "replay": false,
  "simulated": false,
  "error": null,
  "taskKey": "server:507f1f77bcf86cd799439012:restart:restart_001"
}

參數

id路徑 · 必填

string

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

actionJSON 請求主體 · 必填

"start" | "shutdown" | "stop" | "restart" | "changepass" | "reinstall" | "terminate"

要執行的操作。

requestKeyJSON 請求主體 · 必填

string

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

confirmJSON 請求主體 · 選填

boolean

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

osJSON 請求主體 · 選填

string

作業系統識別碼。內建選項包括 debian12 與 ubuntu24;系統會依所選方案檢查可用性與授權。伺服器操作及其挑戰中,只有 reinstall 接受 os。

proofJSON 請求主體 · 選填

object

AI 執行 terminate/reinstall 的同意證明:{ challengeId: string(24 個十六進位字元), signature: string(20–200 個字元)}。請針對相同的 action、requestKey 與作業系統取得挑戰,再於本機簽署完整原始訊息。

回應

HTTP 狀態 200 / 202

回傳已提交的伺服器操作回執;結果為等待中或不確定時,請查詢原工作。

okboolean

底層操作是否回報 ok。

pendingboolean

為 true 時 HTTP 狀態為 202,否則為 200。

replayboolean

是否為原始請求的重播結果。

simulatedboolean

此操作是否使用隔離測試行為。

errorunknown | null

底層操作的錯誤值,或 null;未定義更具體的執行期輸出格式。

taskKeystring

固定鍵值 server:<platform-server-id>:<action>:<requestKey>。