Skip to content

查詢雲端同步狀態 ​

查詢某個環境的雲端同步開關與帳號狀態。介面只讀本機儲存的狀態,不會向 OSS 或 WebDAV 發起任何請求,可以放心在輪詢或健康檢查裡呼叫。

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

請求 ​

http
GET /api/getCloudSyncStatus?id=1
api-key: REPLACE_WITH_LOCAL_API_KEY

需保持客戶端執行並已登入會員帳號。從客戶端 API 頁面複製實際本機服務地址和 api-key;API 埠動態分配,不是瀏覽器 CDP 埠。參見概述與鑑權。

Query 引數 ​

引數型別必填說明
idinteger是環境 ID,正整數;從環境列表獲取

cURL ​

bash
BASE_URL='http://127.0.0.1:REPLACE_WITH_API_PORT'
API_KEY='REPLACE_WITH_LOCAL_API_KEY'
curl --get "${BASE_URL}/api/getCloudSyncStatus" \
  --header "api-key: ${API_KEY}" \
  --data-urlencode 'id=1'

響應範例 ​

json
{
  "success": true,
  "data": {
    "id": 1,
    "enabled": true,
    "cloudId": "0f1e2d3c-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "provider": "oss",
    "loggedIn": true,
    "vip": true,
    "hasSyncPassword": true
  }
}
欄位型別說明
data.enabledboolean該環境的雲端同步開關是否開啟
data.cloudIdstring雲端環境 ID;從未同步過的環境可能為空字串
data.providerstring該環境使用的儲存提供方:oss 或 webdav
data.loggedInboolean客戶端當前是否已登入
data.vipboolean當前帳號是否具備會員許可權(雲端同步依賴會員)
data.hasSyncPasswordboolean是否已設定同步密碼;未設定時無法透過密碼恢復備份

說明 ​

  • enabled 只表示開關狀態,不代表雲端已有備份。要確認雲端是否存在備份,請呼叫列出雲端備份。
  • id 缺失或不是正整數返回 HTTP 400。
  • 未登入或會員過期時介面仍可呼叫,但 loggedIn / vip 會是 false;此時開啟同步會失敗,返回 HTTP 403(VIP capability lease is missing or expired)。
  • 關閉雲端同步請使用設定雲端同步開關。