云端浏览器 API

读取浏览器会话

读取当前账户的指定会话及其最新状态,sessionId 使用创建或列表返回的 id。expand=debug,events 可同时取得实时观看地址和事件首页;不存在或不属于当前账户时返回 404。

GET /browser/v1/sessions/{sessionId}● 支持

请求参数

  • sessionIdstring必填

    浏览器会话 ID;使用创建或列出会话返回的 id,以 bss_ 开头。

  • expandstring可选

    逗号分隔的 debug、events;在同一响应中返回调试地址和事件。

返回

200

错误含 statusCode、error、message;自有面另含 code。请求 ID 见 X-Request-Id。 错误

连接与使用指南

响应

HTTP 200

请求成功。

application/json

名称类型说明
idstring浏览器会话 ID;使用创建或列出会话返回的 id,以 bss_ 开头。
projectIdstring兼容项目标识,当前账户的会话固定返回 default。
statusstring会话生命周期状态;释放中的会话仍显示 RUNNING,但已不能建立新连接。
keepAlivebooleanAPI 创建的会话是否在客户端断开后保留;true 不因空闲释放,仍受最长寿命限制。
regionstring兼容字段,不代表可选择部署区域。
proxyBytesinteger兼容的代理流量字节数;当前未使用代理,固定返回 0。
createdAtstring会话创建时刻,UTC ISO 8601 时间。
updatedAtstring会话状态最近一次更新的时刻,UTC ISO 8601 时间。
startedAtstring浏览器开始运行的时刻;尚未开始运行时返回创建时刻,UTC ISO 8601 时间。
expiresAtstring会话最长寿命的到期时刻,等于创建时刻加 timeout 秒,UTC ISO 8601 时间。
endedAtstring浏览器使用区间的结束时刻,UTC ISO 8601 时间;尚未记录结束时刻时省略。
contextIdstring登录态 ID;使用创建或列出登录态返回的 id,以 bsc_ 开头。
userMetadataobject创建会话时传入的自定义 JSON 元数据;未设置时为空对象。
namestring会话名称;1–128 个 ASCII 字母、数字或 . _ : -,可用于筛选会话。
labelsobject自定义字符串标签;最多 32 项,键最多 128 个 UTF-8 字节,值最多 1024 个 UTF-8 字节。
originstring会话创建入口;api 为 API 创建,connect 为一步连接创建,console 为 Console 创建。
closeReasonstring会话释放原因;未开始释放时省略。
viewportobject浏览器视口尺寸;创建时省略整个对象则使用宽 1280、高 800 像素。
viewport.widthinteger浏览器视口宽度,单位为像素,必须为正整数。
viewport.heightinteger浏览器视口高度,单位为像素,必须为正整数。
billedSecondsnumber会话计费时长,单位为秒;运行时随时长增长,结束后为最终计费时长,可含小数。
currentUrlstring最近观察到的页面导航地址;尚未观察到导航时省略。
clientsinteger当前连接的 CDP 客户端数量;不包含仅观看页面的用户。
handoffobject | null待完成的人工接管请求;没有请求、已完成或已过期时为 null。
handoff.messagestring请求人工接管时提供给操作者的说明文字。
handoff.requestedAtstring人工接管请求的发起时刻,UTC ISO 8601 时间。
handoff.expiresAtstring人工接管请求的失效时刻,UTC ISO 8601 时间。
debugobject会话和标签页的实时观看地址,以及当前会话的 CDP 连接地址。
debug.debuggerFullscreenUrlstring会话实时画面的完整跳转地址,携带观看凭证;与 debuggerUrl 相同。
debug.debuggerUrlstring会话实时画面的完整跳转地址;直接打开,勿移除查询凭证。
debug.wsUrlstring连接当前会话的 CDP WebSocket 地址,自带 signingKey,无需额外 API Key。
debug.pagesarray<object>当前浏览器标签页及各页的实时观看地址;会话不在运行状态时为空数组。
eventsobjectexpand 包含 events 时返回的会话事件首页;后续页通过事件列表读取。
events.dataarray<object>本页查询匹配的记录;没有匹配项时为空数组。
events.nextCursorstring | null下一页游标;原样传入 cursor,null 表示没有更多结果。