云端浏览器 API

更新登录态

更新登录态的名称和标签并返回更新后的对象,不修改已保存的 cookie 或 localStorage。省略字段保留原值;空名称清除名称,传入 labels 会整体替换标签,空对象清除标签。

PUT /browser/v1/contexts/{contextId}● 支持

请求参数

  • contextIdstring必填

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

  • namestring可选

    登录态名称;非空时为 1–128 个 ASCII 字母、数字或 . _ : -,在当前账户内唯一;空字符串表示不设名称或清除名称。

  • labelsobject可选

    自定义字符串标签;最多 32 项,键最多 128 个 UTF-8 字节,值最多 1024 个 UTF-8 字节。 更新时整体替换;空对象清除标签,省略则保留。

返回

200

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

连接与使用指南

响应

HTTP 200

请求成功。

application/json

名称类型说明
idstring登录态 ID;使用创建或列出登录态返回的 id,以 bsc_ 开头。
projectIdstring兼容项目标识,当前账户的登录态固定返回 default。
createdAtstring登录态创建时刻,UTC ISO 8601 时间。
updatedAtstring登录态名称、标签或保存内容最近一次更新的时刻,UTC ISO 8601 时间。
namestring登录态名称;非空时为 1–128 个 ASCII 字母、数字或 . _ : -,在当前账户内唯一;空字符串表示不设名称或清除名称。
labelsobject自定义字符串标签;最多 32 项,键最多 128 个 UTF-8 字节,值最多 1024 个 UTF-8 字节。
sitesarray<string>已保存的 localStorage 主机名和 cookie 域名,去掉 cookie 域名前导点后去重排序。
cookieCountinteger登录态中已保存的 cookie 条目数量;新登录态为 0。
bytesinteger登录态加密后保存内容的大小,单位为 UTF-8 字节。
lockedBystring当前登录态写入租约的持有者标识;无有效租约时省略。
lastUsedAtstring