跳转到内容

设置云同步开关 ​

开启或关闭某个环境的云同步。开启时默认会立即上传一次,用于把环境包与账号密码信封推到云端。

接口定义: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。
  • 只想看当前状态、不改动设置时,用查询云同步状态。