云端浏览器 API

创建浏览器会话

创建云端 Chrome,返回自带凭证的 connectUrl。API 会话默认断开后结束;最长 6 小时。

POST /browser/v1/sessions● 支持

请求参数

  • projectIdstring可选

    可省略;账户使用 default 项目。

  • keepAliveboolean可选
    默认 false

    false 时最后一个客户端断开且无人观看后结束会话;true 时保留至关闭或超时。

  • timeoutnumber可选
    默认 3600

    从创建时刻起算的会话最长寿命,单位为秒;可含小数。

  • browserSettingsobject可选

    创建浏览器时的登录态、视口及兼容选项;省略时不加载已保存的登录态。

    ▸ 展开子字段(13)
    • contextobject可选

      新会话使用的已保存登录态;必须属于当前账户;persist 为 true 时同一登录态只能有一个写入会话。

      ▸ 展开子字段(2)
      • idstring必填

        登录态 ID;使用创建或列出登录态返回的 id,以 bsc_ 开头。

      • persistboolean可选
        默认 false

        关闭会话时合并保存 cookie 和 localStorage;false 只读取登录态;不保存 IndexedDB。

    • viewportobject可选

      浏览器视口尺寸;创建时省略整个对象则使用宽 1280、高 800 像素。

      ▸ 展开子字段(2)
      • widthinteger必填

        浏览器视口宽度,单位为像素,必须为正整数。

      • heightinteger必填

        浏览器视口高度,单位为像素,必须为正整数。

    • blockAdsboolean可选◐ 部分支持

      接受但忽略;不会启用此能力。

    • solveCaptchasboolean可选◐ 部分支持

      接受但忽略;不会启用此能力。

    • recordSessionboolean可选◐ 部分支持

      接受但忽略;不会启用此能力。

    • logSessionboolean可选◐ 部分支持

      接受但忽略;不会启用此能力。

    • extensionIdstring可选○ 未支持

      不支持此配置。

    • verifiedboolean可选○ 未支持

      不支持此配置。

    • advancedStealthboolean可选○ 未支持

      不支持此配置。

    • osstring可选○ 未支持

      不支持此配置。

    • fingerprintobject可选○ 未支持

      不支持此配置。

    • allowedDomainsarray可选○ 未支持

      不支持此配置。

    • ignoreCertificateErrorsboolean可选○ 未支持

      不支持此配置。

  • proxiesunion可选◐ 部分支持

    仅省略、false 或 [{type: 'none'}] 可用,其它代理配置返回 501。

  • regionstring可选◐ 部分支持

    接受但忽略;不会启用此能力。

  • extensionIdstring可选○ 未支持

    不支持此配置。

  • userMetadataobject可选

    自定义 JSON 元数据;序列化后的长度最多为 512 个 UTF-16 代码单元。

  • namestring可选

    会话名称;1–128 个 ASCII 字母、数字或 . _ : -,可用于筛选会话。

  • labelsobject可选

    自定义字符串标签;最多 32 项,键最多 128 个 UTF-8 字节,值最多 1024 个 UTF-8 字节。

返回

201

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

连接与使用指南

响应

HTTP 201

请求成功。

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 时间。
connectUrlstring自带凭证的 CDP WebSocket 地址,有效期覆盖会话寿命;连接无需额外 API Key。
signingKeystringconnectUrl 内的连接凭证,请勿公开。
seleniumRemoteUrlstring该地址返回 501;不支持 Selenium。