v0.11.0

HTTP API

最後更新


本頁列出 API Server 的端點、請求格式與資料表結構。

端點


API Server 監聽 :8080,成功時回傳 ok 字串或 {"data": [...]};JSON 綁定失敗回 400,資料庫錯誤回 500,內容皆為錯誤訊息字串。
方法路徑Body說明
GET/api/health—健康檢查,回傳 ok
GET/api/pod/list—列出 dismiss = 0 的部署
POST/api/pod/upsertPod依 uid 新增或更新部署,並重設 dismiss = 0
POST/api/pod/update/:uidPod(只取 status、dismiss)更新指定部署
POST/api/pod/record/insertRecord(取 uid、content、hostname、ip)依 uid 寫入一筆操作紀錄

未註冊的路徑由 NoRoute 處理,請求會一直掛著不回應。

範例


  1. curl -X POST localhost:8080/api/pod/upsert \
  2. -d '{"uid":"t1","pod_id":"p","pod_name":"n","local_dir":"/a","remote_dir":"/b","status":"starting","replicas":1}'
  3. curl localhost:8080/api/pod/list

Pod 欄位


欄位型別說明
uidstringmd5("<MAC>@<本地絕對路徑>") 或 -u 指定值
pod_idstringPodman Pod ID;查不到時為遠端目錄名
pod_namestringPodman Pod 名稱;查不到時為遠端目錄名
local_dirstring本地專案絕對路徑
remote_dirstring/home/podrun/<目錄名>_<雜湊前 8 碼>
filestring-f 指定的 compose 檔
targetstring--type 的值;[未完成] k3s 僅作紀錄
statusstringup 後為 starting;removePod() 後為空字串
hostnamestring執行 CLI 的主機名稱
ipstring執行 CLI 的主機第一個非 loopback IPv4
replicasint固定為 1
created_at/updated_attime由資料庫寫入
dismissint0 有效、1 已移除

pod_id 寫入資料表的 pod_uid 欄位。

資料表


資料表用途欄位
pods每個部署一列,uid 與 pod_uid 唯一uid、pod_uid、pod_name、local_dir、remote_dir、file、target、status、hostname、ip、replicas、created_at、updated_at、dismiss
records操作紀錄,pod_id 參照 pods.id(刪除時連動)pod_id、content、hostname、ip
domains[未完成] 預留給 domain 指令pod_id、container_name、domain、created_at、updated_at、dismiss
EN