云端浏览器 API
列出浏览器会话
分页列出当前账户的浏览器会话,按创建时刻及 ID 降序排列。可组合状态、名称、标签和用户元数据筛选;将返回的 nextCursor 原样传入以继续读取。
GET
/browser/v1/sessions● 支持请求参数
statusstring可选按会话生命周期状态筛选;省略时返回所有状态。
qstring可选按单个用户元数据键的字符串值精确筛选,例如 user_metadata['purpose']:'docs'。
namestring可选按会话名称精确匹配;省略时不按名称筛选。
labelsstring可选JSON 编码的标签对象;仅返回同时匹配所有标签键值的会话。
cursorstring可选上一页返回的 nextCursor,原样传入以继续读取;省略时读取第一页。
limitinteger可选每页最多返回的记录数量;默认 50,范围 1–200。
返回
200
错误含 statusCode、error、message;自有面另含 code。请求 ID 见 X-Request-Id。 错误
响应
HTTP 200
请求成功。
application/json
| 名称 | 类型 | 说明 |
|---|---|---|
| data | array<object> | 本页查询匹配的记录;没有匹配项时为空数组。 |
| data[].id | string | 浏览器会话 ID;使用创建或列出会话返回的 id,以 bss_ 开头。 |
| data[].projectId | string | 兼容项目标识,当前账户的会话固定返回 default。 |
| data[].status | string | 会话生命周期状态;释放中的会话仍显示 RUNNING,但已不能建立新连接。 |
| data[].keepAlive | boolean | API 创建的会话是否在客户端断开后保留;true 不因空闲释放,仍受最长寿命限制。 |
| data[].region | string | 兼容字段,不代表可选择部署区域。 |
| data[].proxyBytes | integer | 兼容的代理流量字节数;当前未使用代理,固定返回 0。 |
| data[].createdAt | string | 会话创建时刻,UTC ISO 8601 时间。 |
| data[].updatedAt | string | 会话状态最近一次更新的时刻,UTC ISO 8601 时间。 |
| data[].startedAt | string | 浏览器开始运行的时刻;尚未开始运行时返回创建时刻,UTC ISO 8601 时间。 |
| data[].expiresAt | string | 会话最长寿命的到期时刻,等于创建时刻加 timeout 秒,UTC ISO 8601 时间。 |
| data[].endedAt | string | 浏览器使用区间的结束时刻,UTC ISO 8601 时间;尚未记录结束时刻时省略。 |
| data[].contextId | string | 登录态 ID;使用创建或列出登录态返回的 id,以 bsc_ 开头。 |
| data[].userMetadata | object | 创建会话时传入的自定义 JSON 元数据;未设置时为空对象。 |
| data[].name | string | 会话名称;1–128 个 ASCII 字母、数字或 . _ : -,可用于筛选会话。 |
| data[].labels | object | 自定义字符串标签;最多 32 项,键最多 128 个 UTF-8 字节,值最多 1024 个 UTF-8 字节。 |
| data[].origin | string | 会话创建入口;api 为 API 创建,connect 为一步连接创建,console 为 Console 创建。 |
| data[].closeReason | string | 会话释放原因;未开始释放时省略。 |
| data[].viewport | object | 浏览器视口尺寸;创建时省略整个对象则使用宽 1280、高 800 像素。 |
| data[].billedSeconds | number | 会话计费时长,单位为秒;运行时随时长增长,结束后为最终计费时长,可含小数。 |
| data[].currentUrl | string | 最近观察到的页面导航地址;尚未观察到导航时省略。 |
| data[].clients | integer | 当前连接的 CDP 客户端数量;不包含仅观看页面的用户。 |
| data[].handoff | object | null | 待完成的人工接管请求;没有请求、已完成或已过期时为 null。 |
| nextCursor | string | null | 下一页游标;原样传入 cursor,null 表示没有更多结果。 |