跳转到内容
Local API环境管理

获取环境详情 ​

版本概览
GET
/api/v1/browsers/{envId}

返回当前用户、当前团队下的指定环境,并叠加 active/inactive 状态和本机可用性。

请求参数

Authorization Bearer Token

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

Authorization: Bearer <api-key>

Path 参数

1
字段说明
string必填
浏览器环境唯一标识
示例值"env_01JABCDEF1234567890"
minLength: 1

请求示例代码

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

curl -H 'Authorization: Bearer <TOKEN>' 'http://local.zhongyibrowser.com:39025/api/v1/browsers/env_01JABCDEF1234567890'

返回响应

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

指定环境详情

Body

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

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

{
  "code": 0,
  "message": "success",
  "data": {
    "env_id": "env_01JABCDEF1234567890",
    "env_sn": "string",
    "env_name": "string",
    "sort": 0,
    "remark": "string",
    "group": {
      "id": "string",
      "name": "string"
    },
    "kernel_version": "string",
    "is_available": true,
    "unavailable_reason": "package_limit",
    "status": "active",
    "headless": true,
    "ws_endpoint": "string"
  }
}

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

中屹浏览器 Local API 文档