跳转到内容
Local API代理管理

替换代理绑定环境 ​

版本概览
PUT
/api/v1/proxies/{proxy_id}/browsers

使用完整替换语义设置代理绑定的环境列表,支持 custom、api、integ、syt 四种代理。重复环境 ID 自动去重,空数组表示解绑全部。Local API 会先校验代理和全部环境均属于当前用户、当前团队;任何环境不存在或不可访问时整体返回 404,不调用后端绑定接口。该操作只更新代理绑定和环境代理信息,不启动或关闭浏览器。

请求参数

Authorization Bearer Token

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

Authorization: Bearer <api-key>

Path 参数

1
字段说明
string必填
代理唯一标识
示例值"proxy_01JABCDEF1234567890"
minLength: 1

Body 参数

必填application/jsonProxyBindBrowsersRequest
字段说明
string[]必填
绑定到该代理的完整环境 ID 列表;重复值自动去重,空数组表示解绑全部环境
示例

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

{
  "env_ids": [
    "env_01JABCDEF1234567890"
  ]
}

请求示例代码

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

curl -X PUT -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' -d '{
  "env_ids": [
    "env_01JABCDEF1234567890"
  ]
}' 'http://local.zhongyibrowser.com:39025/api/v1/proxies/proxy_01JABCDEF1234567890/browsers'

返回响应

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

代理最终环境绑定关系

Body

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

不允许额外字段。

示例

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

{
  "code": 0,
  "message": "success",
  "data": {
    "proxy_id": "proxy_01JABCDEF1234567890",
    "browser_ids": [
      "env_01JABCDEF1234567890"
    ],
    "browser_count": 0
  }
}

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

中屹浏览器 Local API 文档