Skip to content

設定雲端同步開關 ​

開啟或關閉某個環境的雲端同步。開啟時預設會立即上傳一次,用於把環境包與帳號密碼信封推到雲端。

介面定義:POST · 核對日期:2026-11-19。

請求 ​

http
POST /api/setCloudSync
api-key: REPLACE_WITH_LOCAL_API_KEY

從客戶端 API 頁面複製實際本機服務地址和 api-key;API 埠動態分配,不是瀏覽器 CDP 埠。參見概述與鑑權。

JSON 請求體 ​

引數型別必填說明
idinteger是環境 ID,正整數
enableboolean是true 開啟,false 關閉
syncNowboolean否開啟時是否立即上傳一次,預設 true;關閉環境同步時忽略
waitboolean否true 時同步等待上傳完成後才返回;大環境建議保持非同步,避免請求超時

cURL ​

bash
BASE_URL='http://127.0.0.1:REPLACE_WITH_API_PORT'
API_KEY='REPLACE_WITH_LOCAL_API_KEY'
curl --request POST "${BASE_URL}/api/setCloudSync" \
  --header "api-key: ${API_KEY}" \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 1,
  "enable": true,
  "syncNow": true,
  "wait": false
}'

響應範例 ​

json
{
  "success": true,
  "data": {
    "id": 1,
    "enabled": true,
    "syncTriggered": true
  }
}
欄位型別說明
data.enabledboolean設定後的開關狀態
data.syncTriggeredboolean本次是否觸發了立即上傳;syncNow 為 false 或關閉同步時為 false

說明 ​

  • syncTriggered 只表示上傳任務已開始,不代表雲端已經儲存完成。需要確認結果時,配合 wait: true 使用,或在稍後呼叫列出雲端備份檢視。
  • 關閉同步只停止後續上傳,不會刪除雲端已有備份;要清理雲端資料請呼叫刪除雲端備份。
  • 未登入或會員過期返回 HTTP 403(VIP capability lease is missing or expired);id、enable 缺失或型別不對返回 HTTP 400。
  • 只想看當前狀態、不改動設定時,用查詢雲端同步狀態。