跳转到内容
Local API环境管理

关闭所有环境 ​

版本概览
POST
/api/v1/browsers/stop/all

对请求到达时环境管理模块中已打开的浏览器创建快照,并按当前登录用户和团队逐项校验、关闭。接口不操作 RPA/RPA Plus runtime;部分环境失败不影响其他环境,响应结构与批量停止一致。

请求参数

Authorization Bearer Token

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

Authorization: Bearer <api-key>

Body 参数

application/jsonBrowserStopAllRequest
字段说明
integer
最大并发关闭数,默认 5、最大 10
默认值5
minimum: 1maximum: 10
示例

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

{
  "concurrency": 5
}

请求示例代码

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 '{
  "concurrency": 5
}' 'http://local.zhongyibrowser.com:39025/api/v1/browsers/stop/all'

返回响应

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

批量请求处理完成后,即使部分项失败,外层仍可能返回 HTTP 200、code = 0。请检查 data.items[].success 和 data.items[].error 判断各项结果。

所有环境的逐项关闭结果

Body

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

不允许额外字段。

示例

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

{
  "code": 0,
  "message": "success",
  "data": {
    "total": 0,
    "success_count": 0,
    "failed_count": 0,
    "items": [
      {
        "env_id": "env_01JABCDEF1234567890",
        "success": true,
        "data": {
          "status": "inactive"
        }
      }
    ]
  }
}

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

中屹浏览器 Local API 文档