Skip to content
Home » Local API V2 – 运行状态接口

Local API V2 – 运行状态接口

  • by

查询服务状态

接口地址

GET /openapi/v2/status

用于确认 Local API 服务是否可用，并返回当前服务端口、版本和宿主类型。

响应示例

{
  "code": 0,
  "msg": "success",
  "data": {
    "service": "dicloak-local-api",
    "status": "ok",
    "api_version": "2.0.0",
    "client_version": "2.9.11",
    "port": 52100,
    "auth_required": true,
    "host": "desktop"
  },
  "next": null
}

查询版本信息

接口地址

GET /openapi/v2/version

用于查询 Local API 版本、客户端版本、系统平台和本地已安装的浏览器内核版本信息。

响应示例

{
  "code": 0,
  "msg": "success",
  "data": {
    "api_version": "2.0.0",
    "client_version": "2.9.11",
    "platform": "darwin",
    "arch": "arm64",
    "kernel": {
      "installed": ["142.0.7444.60"]
    },
    "host": "desktop"
  },
  "next": null
}

查询能力声明

接口地址

GET /openapi/v2/capabilities

用于查询当前 Local API 支持的能力，适合调用方在运行时判断是否可以使用环境、代理、Cookie、指纹、书签、扩展、标签、环境分组、成员权限、运行状态和内核查询等接口。

响应中的字段为布尔值。true 表示当前 Local API 宿主支持该能力，false 表示该能力属于已知可选能力，但当前阶段不可用。

响应示例

{
  "code": 0,
  "msg": "success",
  "data": {
    "profiles": true,
    "cookies": true,
    "proxies": true,
    "fingerprints": true,
    "bookmarks": true,
    "extensions": true,
    "tags": true,
    "profile_groups": true,
    "members": true,
    "member_groups": true,
    "permissions": true,
    "start_stop": true,
    "stop_all": true,
    "sessions": true,
    "kernels": true,
    "kernel_actions": false,
    "tabs": false,
    "host": "desktop"
  },
  "next": null
}

查询健康状态

接口地址

GET /openapi/v2/health

用于查询 Local API 当前健康状态，以及认证、运行态查询、API 服务连接和内核数据来源是否可用。

响应示例

{
  "code": 0,
  "msg": "success",
  "data": {
    "status": "ok",
    "checks": {
      "local_api": "ok",
      "auth": "ok",
      "runtime_bridge": "ok",
      "backend_forwarder": "configured",
      "kernel_provider": "ok"
    },
    "host": "desktop"
  },
  "next": null
}

查询频控说明

接口地址

GET /openapi/v2/rate-limits

用于查询当前 Local API 请求可能受到的本地频控和服务端频控说明。

响应示例

{
  "code": 0,
  "msg": "success",
  "data": {
    "local": {
      "enabled": true,
      "strategy": "koa-ratelimit",
      "limit": 60,
      "window_ms": 6000
    },
    "backend": {
      "enabled": true,
      "strategy": "backend-managed"
    },
    "host": "desktop"
  },
  "next": null
}

查询正在运行的环境

接口地址

GET /openapi/v2/sessions

用于查询当前设备正在运行的环境列表，包括进程 ID、调试端口和 WebSocket 地址等运行态信息。

响应示例

{
  "code": 0,
  "msg": "success",
  "data": {
    "items": [
      {
        "session_id": "desktop:1876881021063852034:12345",
        "profile_id": "1876881021063852034",
        "serial_no": 166,
        "name": "facebook-01",
        "status": "running",
        "pid": "12345",
        "debug_port": 17539,
        "web_socket_url": "ws://127.0.0.1:17539/devtools/browser/xxx",
        "started_at": null,
        "host": "desktop"
      }
    ]
  },
  "next": null
}

停止全部正在运行的环境

接口地址

POST /openapi/v2/sessions/stop-all

用于停止当前设备上正在运行的全部环境。默认会按完整关闭流程处理每个环境，包括关闭后的数据同步。

请求参数

请求体可选。不传请求体时，按默认完整关闭流程执行。

名称类型必填说明
skip_cookie_sync_after_closeboolean否是否跳过停止后 Cookie 同步。
skip_data_sync_after_closeboolean否是否跳过停止后数据同步。
skip_extension_sync_after_closeboolean否是否跳过停止后扩展数据同步。

请求示例

 {
    "skip_cookie_sync_after_close": false,
    "skip_data_sync_after_close": false,
    "skip_extension_sync_after_close": false
  }

响应示例

{
  "code": 0,
  "msg": "success",
  "data": {
    "requested": 2,
    "closed": ["1876881021063852034"],
    "forced": [],
    "failed": []
  },
  "next": null
}

查询指定环境运行状态

接口地址

GET /openapi/v2/profiles/{profileId}/session

用于查询指定环境在当前设备上的运行状态。环境未运行时仍返回成功，data.status 为 stopped。

路径参数

名称类型必填说明
profileIdstring是环境 ID

未运行响应示例

{
  "code": 0,
  "msg": "success",
  "data": {
    "session_id": null,
    "profile_id": "1876881021063852034",
    "serial_no": null,
    "name": null,
    "status": "stopped",
    "pid": null,
    "debug_port": null,
    "web_socket_url": null,
    "started_at": null,
    "host": "desktop"
  },
  "next": null
}

查询已安装内核

接口地址

GET /openapi/v2/kernels

用于查询当前设备已安装的浏览器内核列表。

响应示例

{
  "code": 0,
  "msg": "success",
  "data": {
    "items": [
      {
        "kernel_version": "142.0.7444.60",
        "name": "Chromium 142.0.7444.60",
        "status": "loaded",
        "installed": true,
        "loaded": true,
        "platform": "darwin",
        "arch": "arm64",
        "progress_percent": null,
        "host": "desktop"
      }
    ]
  },
  "next": null
}