Hivebrowser
API 参考

用量与设置

用量指标、运行节点状态与团队设置。

用途运营可见性

围绕用量、运行节点健康状态和团队运行设置构建看板与支持检查。

诊断区分容量和代码失败

把失败会话与运行节点可用性、配额和团队限制一起对照。

控制变更必须有归属

团队设置和运行节点状态更新应视为有明确负责人的管理动作。

运营边界

用量接口用于看运行时消耗，运行节点接口用于区分容量问题和代码失败，团队设置接口用于检查影响新建会话的限制与默认值。更新运行节点状态或团队设置应视为管理动作，需要明确归属和审计。

查询用量汇总

GET/v1/usage查看接口细节收起接口细节
GET/v1/usage

鉴权

Authorization必填Bearer <token>

在 Authorization 请求头中以 Bearer 令牌形式传入 API 密钥。

位置：header

x-hivebrowser-api-key<token>

也可以直接通过 x-hivebrowser-api-key 请求头传入 API 密钥。

位置：header

cURL
curl -X GET "https://api.hivebrowser.ai/v1/usage" \  -H "Authorization: Bearer <token>"
JavaScript
fetch("https://api.hivebrowser.ai/v1/usage", {  headers: {    "Authorization": "Bearer <token>"  }});
响应 200

用量汇总

响应示例
{
  "data": {
    "totals": {
      "property1": 0,
      "property2": 0
    },
    "recentEvents": {
      "items": [
        {
          "id": "string",
          "teamId": "string",
          "sessionId": "string",
          "profileId": "string",
          "artifactId": "string",
          "type": "string",
          "quantity": "string",
          "unit": "string",
          "metadata": {},
          "occurredAt": "2019-08-24T14:15:22Z",
          "createdAt": "2019-08-24T14:15:22Z"
        }
      ],
      "total": 0,
      "page": 1,
      "pageSize": 0
    }
  }
}
响应 401

API 密钥缺失或无效

响应示例
{
  "error": "string",
  "message": "string"
}

列出运行节点

GET/v1/runners查看接口细节收起接口细节
GET/v1/runners

鉴权

Authorization必填Bearer <token>

在 Authorization 请求头中以 Bearer 令牌形式传入 API 密钥。

位置：header

x-hivebrowser-api-key<token>

也可以直接通过 x-hivebrowser-api-key 请求头传入 API 密钥。

位置：header

cURL
curl -X GET "https://api.hivebrowser.ai/v1/runners" \  -H "Authorization: Bearer <token>"
JavaScript
fetch("https://api.hivebrowser.ai/v1/runners", {  headers: {    "Authorization": "Bearer <token>"  }});
响应 200

运行节点列表

响应示例
{
  "data": {
    "items": [
      {
        "id": "string",
        "region": "string",
        "hostname": "string",
        "status": "ONLINE",
        "apiBaseUrl": "string",
        "connectBaseUrl": "string",
        "liveBaseUrl": "string",
        "maxSessionCount": 0,
        "currentSessionCount": 0,
        "labels": {},
        "lastHeartbeatAt": "2019-08-24T14:15:22Z",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z"
      }
    ],
    "total": 0,
    "page": 1,
    "pageSize": 0
  }
}
响应 401

API 密钥缺失或无效

响应示例
{
  "error": "string",
  "message": "string"
}

更新运行节点状态

POST/v1/runners/{id}/status查看接口细节收起接口细节
POST/v1/runners/{id}/status

鉴权

Authorization必填Bearer <token>

在 Authorization 请求头中以 Bearer 令牌形式传入 API 密钥。

位置：header

x-hivebrowser-api-key<token>

也可以直接通过 x-hivebrowser-api-key 请求头传入 API 密钥。

位置：header

请求体

application/json必填
status必填字符串

新的运行节点状态

可选值: "ONLINE" | "DRAINING"

路径参数

id必填字符串

运行节点 ID

cURL
curl -X POST "https://api.hivebrowser.ai/v1/runners/string/status" \  -H "Authorization: Bearer <token>" \  -H "Content-Type: application/json" \  -d '{    "status": "ONLINE"  }'
JavaScript
fetch("https://api.hivebrowser.ai/v1/runners/string/status", {  headers: {    "Authorization": "Bearer <token>"  },  body: JSON.stringify({    "status": "ONLINE"  })});
响应 200

运行节点状态已更新

响应示例
{
  "data": {
    "id": "string",
    "region": "string",
    "hostname": "string",
    "status": "ONLINE",
    "apiBaseUrl": "string",
    "connectBaseUrl": "string",
    "liveBaseUrl": "string",
    "maxSessionCount": 0,
    "currentSessionCount": 0,
    "labels": {},
    "lastHeartbeatAt": "2019-08-24T14:15:22Z",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}
响应 400

请求载荷无效

响应示例
{
  "error": "string",
  "message": "string"
}
响应 401

API 密钥缺失或无效

响应示例
{
  "error": "string",
  "message": "string"
}
响应 404

资源不存在

响应示例
{
  "error": "string",
  "message": "string"
}

查询团队设置

GET/v1/team/settings查看接口细节收起接口细节
GET/v1/team/settings

鉴权

Authorization必填Bearer <token>

在 Authorization 请求头中以 Bearer 令牌形式传入 API 密钥。

位置：header

x-hivebrowser-api-key<token>

也可以直接通过 x-hivebrowser-api-key 请求头传入 API 密钥。

位置：header

cURL
curl -X GET "https://api.hivebrowser.ai/v1/team/settings" \  -H "Authorization: Bearer <token>"
JavaScript
fetch("https://api.hivebrowser.ai/v1/team/settings", {  headers: {    "Authorization": "Bearer <token>"  }});
响应 200

团队设置

响应示例
{
  "data": {
    "id": "string",
    "name": "string",
    "slug": "string",
    "planCode": "string",
    "sessionConcurrencyLimit": 1,
    "sessionMaxDurationSec": 1,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}
响应 401

API 密钥缺失或无效

响应示例
{
  "error": "string",
  "message": "string"
}

更新团队设置

POST/v1/team/settings查看接口细节收起接口细节
POST/v1/team/settings

鉴权

Authorization必填Bearer <token>

在 Authorization 请求头中以 Bearer 令牌形式传入 API 密钥。

位置：header

x-hivebrowser-api-key<token>

也可以直接通过 x-hivebrowser-api-key 请求头传入 API 密钥。

位置：header

请求体

application/json必填
name字符串

团队显示名称

最小长度: 1最大长度: 120
sessionConcurrencyLimit整数

最大并发会话数

最小值: 1最大值: 100
sessionMaxDurationSec整数

最大会话时长（秒，最高 24 小时）

最小值: 1最大值: 86400
cURL
curl -X POST "https://api.hivebrowser.ai/v1/team/settings" \  -H "Authorization: Bearer <token>" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "sessionConcurrencyLimit": 1,    "sessionMaxDurationSec": 1  }'
JavaScript
fetch("https://api.hivebrowser.ai/v1/team/settings", {  headers: {    "Authorization": "Bearer <token>"  },  body: JSON.stringify({    "name": "string",    "sessionConcurrencyLimit": 1,    "sessionMaxDurationSec": 1  })});
响应 200

团队设置已更新

响应示例
{
  "data": {
    "id": "string",
    "name": "string",
    "slug": "string",
    "planCode": "string",
    "sessionConcurrencyLimit": 1,
    "sessionMaxDurationSec": 1,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}
响应 400

请求载荷无效

响应示例
{
  "error": "string",
  "message": "string"
}
响应 401

API 密钥缺失或无效

响应示例
{
  "error": "string",
  "message": "string"
}

本页目录

运营边界查询用量汇总列出运行节点更新运行节点状态查询团队设置更新团队设置