跳转到内容

查询云同步状态 ​

查询某个环境的云同步开关与账号状态。接口只读本地保存的状态,不会向 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)。
  • 关闭云同步请使用设置云同步开关。