跳转到内容
Local API服务

获取服务状态 ​

版本概览
GET
/api/v1/status

无需 API Key,用于确认本机服务是否正在运行。

请求参数

此接口无需 API Key。

请求示例代码

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

curl 'http://local.zhongyibrowser.com:39025/api/v1/status'

返回响应

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

服务状态

Body

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

不允许额外字段。

示例

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

{
  "code": 0,
  "message": "success",
  "data": {
    "service": "running",
    "version": "string",
    "port": 39025,
    "base_url": "string",
    "auth_required": true,
    "backend_session": "available",
    "browser_count": 0,
    "started_at": "2024-01-15T09:30:00Z"
  }
}

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

中屹浏览器 Local API 文档