跳转到内容
Local API环境管理

重启环境 ​

版本概览
POST
/api/v1/browsers/restart

校验当前登录用户和团队环境后,正常关闭当前活跃浏览器并重新启动。url、window_state、headless 与启动接口语义一致;window_state=last 时恢复上次打开尺寸;未活跃环境返回 40903,成功响应的 reused 固定为 false。

请求参数

Authorization Bearer Token

在请求头 Authorization 中使用 Bearer Token 传入 API Key。

Authorization: Bearer <api-key>

Body 参数

必填application/jsonBrowserRestartRequest
字段说明
string必填
浏览器环境唯一标识
示例值"env_01JABCDEF1234567890"
minLength: 1
string
启动或复用环境后新开标签访问的 HTTP(S) URL
format: "uri"
string
覆盖客户端本地配置中的启动窗口尺寸/状态;normal 按环境设置尺寸,last 恢复上次打开尺寸,minimized 表示最小化,maximized 表示最大化;无头模式忽略
枚举值
boolean
显式覆盖无头模式;未传时沿用环境 command_line 中的 --headless 配置
示例

根据数据模型生成,非实际请求结果。

{
  "env_id": "env_01JABCDEF1234567890"
}

请求示例代码

JavaScript / TypeScript 使用 Node.js 18+ 内置 fetch;PHP 需启用 cURL 扩展;Go 需 1.16+;Java 需 JDK 11+。运行前请替换 Token 和示例参数值。

curl -X POST -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' -d '{
  "env_id": "env_01JABCDEF1234567890"
}' 'http://local.zhongyibrowser.com:39025/api/v1/browsers/restart'

返回响应

成功时 code = 0,失败时 code > 0。选择状态码查看对应字段和示例,展开对象可查看嵌套字段;可选字段可能不返回。

浏览器重启结果

Body

application/jsonBrowserRestartSuccessResponse
字段说明
number必填
业务状态码;成功固定为 0
枚举值
string必填
业务状态信息;成功固定为 success
枚举值
object必填
接口业务数据

不允许额外字段。

示例

根据数据模型生成,非实际请求结果。

{
  "code": 0,
  "message": "success",
  "data": {
    "env_id": "env_01JABCDEF1234567890",
    "group": {
      "id": "string",
      "name": "string"
    },
    "status": "active",
    "headless": true,
    "ws_endpoint": "string",
    "reused": false
  }
}

查看全部业务错误码与 HTTP 状态码

中屹浏览器 Local API 文档