v0.1.7

API 參考

最後更新


本頁一覽 QemuRun-pve 的全部 REST 端點,每組端點的細節在對應子頁。

慣例


項目說明
基底網址http://<主節點 IP>:<PORT>/api
請求格式Content-Type: application/json
驗證無 token;寫入端點以來源 IP 比對 ALLOW_IPS,見 存取控制
同步端點回應成功為純文字 ok;失敗為純文字錯誤訊息與 4xx/5xx
SSE 端點回應text/event-stream,以 event: close 結束,見 SSE 事件
:idVMID 整數;無法解析時同步端點回 500(/status 回 400)

端點一覽


方法路徑回應ALLOW_IPSVM 狀態要求說明頁
GET/health文字 ok——查詢端點
GET/vm/listJSON——查詢端點
GET/vm/:id/status文字——查詢端點
POST/vm/installSSE✓—建立 VM 端點
POST/vm/:id/startSSE✓停止中生命週期端點
POST/vm/:id/rebootSSE✓執行中生命週期端點
POST/vm/:id/shutdown文字 ok✓執行中生命週期端點
POST/vm/:id/stop文字 ok✓執行中生命週期端點
POST/vm/:id/destroy文字 ok✓停止中生命週期端點
POST/vm/:id/set/cpu文字 ok✓停止中資源調整端點
POST/vm/:id/set/memory文字 ok✓停止中資源調整端點
POST/vm/:id/set/disk文字 ok✓停止中資源調整端點
POST/vm/:id/set/nodeSSE✓停止中資源調整端點

靜態檔案


GET /sh/<file> 提供 sh/ 目錄內容,供新 VM 下載 OS 初始化腳本;此路徑不在 /api 之下,也不檢查 ALLOW_IPS。
EN