功能说明 浏览器操作能力用于在 Agent 沙箱中启动浏览器实例，并通过自动化调试地址完成页面访问和程序化控制。 典型应用场景 页面自动化测试：在隔离沙箱中执行页面打开、点击、输入、断言等操作。 任务流程编排：在业务流程中通过代码驱动浏览器完成网页访问与信息采集。 可视化调试排障：通过控制台的 VNC 调试观察浏览器状态，复现和定位问题。 前提条件 已完成 SDK 运行环境与环境变量配置。 已在 Agent 沙箱服务控制台创建可用的浏览器沙箱模板，并记录模板 templateid。 本地已安装 Python 及 Playwright 依赖，并具备网络访问目标页面的权限。 使用限制 template 参数必须填写已创建且可用的浏览器沙箱 templateid。 cdpurl 依赖访问令牌，请妥善保管，避免泄露。 浏览器实例的可用时长受沙箱生命周期和配额策略限制。 当页面需要额外认证（如登录态、验证码）时，自动化脚本可能需要配套处理逻辑。 操作步骤 步骤一：在控制台创建浏览器沙箱模板并记录 templateid 登录 Agent 沙箱服务控制台创建浏览器沙箱模板，创建完成后记录该模板的 templateid，用于代码中创建实例。 步骤二：运行代码并通过 VNC 监控浏览器 运行下列代码后，在 Agent 沙箱控制台进入对应实例，打开 VNC 调试 查看浏览器实时画面；代码中使用 cdpurl 进行自动化操作。 python from e2b import Sandbox from playwright.syncapi import syncplaywright 请替换为您在控制台记录的templateid templateid "4xxxx3e9xxxxxxxxxxxf22xxx50xxxx" 创建浏览器沙箱实例 sandbox Sandbox.create(templatetemplateid) 拼接 cdp url，用于通过 Playwright 操作浏览器 cdpurl f" print("cdpurl:", cdpurl) with syncplaywright() as playwright: 连接到沙箱浏览器实例 browser playwright.chromium.connectovercdp( cdpurl, headers{"XAccessToken": str(sandbox.envdaccesstoken)} ) 获取第一个上下文与页面并访问目标站点 context browser.contexts[0] page context.pages[0] page.goto(" 输出页面标题，确认操作成功 print("title:", page.title())

步骤四：执行 CDP 指令 1. 在选择执行命令 下拉列表中选择导航到 URL。 2. 在命令参数中输入目标 URL （比如 www.ctyun.cn）。 3. 点击执行命令，查看右侧VNC窗口中的浏览器变化。 步骤五：删除浏览器沙箱实例 1. 任务完成后，返回沙箱实例列表，在目标实例的操作列点击删除。 2. 在弹出的确认框中点击确认。

设置沙箱超时时间 每个沙箱都有一个 timeout（“超时时间”）配置，当沙箱的运行时间超过该配置值时，沙箱将自动关闭并释放。 您可以参考如下方式在启动的时候显式指定 timeout 的配置值，如果未指定，则默认值为 5 分钟。推荐按需设置 timeout 的值，以避免不必要的资源浪费。 python from dotenv import loaddotenv from e2bcodeinterpreter import Sandbox loaddotenv() sbx Sandbox.create(template"codeinterpreter", timeout60) 单位为秒。 代码执行 execution sbx.runcode("print('hello world')") print(execution.logs)

概述 本章节主要介绍使用基础模板base类型创建的沙箱。在该类型沙箱里中可以管理文件系统和执行shell命令功能。 前置操作 1. 登录Agent沙箱控制台。 2. 左侧菜单选择沙箱实例，创建base类型沙箱实例。 3. 点击在线调试，进入base类型沙箱实例。 文件系统管理 创建文件 操作步骤 1. 页面左侧文件浏览器，点击创建文件。 2. 输入文件名，点击创建。 编辑文件 操作步骤 1. 页面左侧文件浏览器，选择文件。 2. 在文件内容区域编辑内容。 创建文件夹 操作步骤 1. 页面左侧文件浏览器，点击创建文件夹。 2. 输入文件夹名，点击创建。 终端执行shell命令 操作步骤 1. 点击连接终端。 2. 输入shell命令，查看执行结果，使用完毕后，点击断开终端 。

概述 本章节主要介绍沙箱模板管理相关功能。 沙箱模板管理 查看沙箱模板 Agent沙箱提供三种模板，即：基础模板base、代码解释器模板codeinterpreter和浏览器模板browserchromium。 操作步骤 1. 登录Agent沙箱控制台。 2. 左侧菜单选择沙箱模板，查看沙箱模板。

参数名称 参数说明 模板 Agent沙箱支持base、codeinterpreter和browserchromium三种类型沙箱模板 超时时间 沙箱存活时长，沙箱创建后超过该时长，会被自动销毁 能否访问公网 默认所有沙箱都能访问公网 能否开启安全访问沙箱 开启后，访问沙箱里面需要鉴权 环境变量 沙箱中会增加配置的环境变量

概述 本章节主要介绍身份凭证管理相关功能。 身份凭证管理 查看身份凭证 操作步骤 1. 登录Agent沙箱控制台。 2. 左侧菜单选择身份凭证，查看身份凭证。 创建身份凭证 操作步骤 1. 登录Agent沙箱控制台。 2. 在身份凭证菜单下，点击创建身份凭证，填写API Key名称，点击确定。 3. 查看API Key的值。 编辑身份凭证 操作步骤 1. 登录Agent沙箱控制台。 2. 在身份凭证菜单下，找到需要编辑的身份凭证，在操作列点击编辑，修改API Key名称，点击确定。 删除身份凭证 操作步骤 1. 登录Agent沙箱控制台。 2. 在身份凭证菜单下，找到需要删除的身份凭证，在操作列点击删除，确认无误后，点击确定。

概述 本章节主要介绍使用代码解释器codeinterpreter模板创建的沙箱。代码解释器沙箱实例提供了一个安全且强大的代码代码执行沙箱环境，在该类型沙箱时里中可以执行以Python、JavaScript等5种语言代码、管理文件系统、执行shell命令等功能。 代码解释器类型沙箱在基础沙箱的基础上，增加了代码运行的能力，这里为了避免赘述，只展示代码运行的功能。 前置操作 1. 登录Agent沙箱控制台。 2. 左侧菜单选择沙箱实例，创建codeinterpreter类型沙箱实例。 3. 点击在线调试，进入codeinterpreter类型沙箱实例。 执行代码 操作步骤 1. 选择需要执行的代码文件，点击运行。 2. 查看代码运行结果。

本文介绍如何使用ECX部署OpenClaw QQ机器人。 注意 配置QQ机器人之前，请先确保已经购买ECX虚拟机并配置大模型服务。具体操作步骤，可参考指引：使用ECX部署OpenClaw。 创建QQ机器人并获取配置 1、注册QQ开放平台账号：登录++QQ开放平台++，默认无法使用个人QQ账号直接登录，需要新注册（可使用您的个人QQ账号申请主体类型为个人的开发者账号）。 说明 您也可以通过QQ开放平台龙虾专用入口快速创建机器人。 对应页面及链接由外部平台提供，可能随时更新，请留意链接有效性、检查域名真实性，谨防访问假冒网站上当受骗。 2、创建机器人。 成功登录QQ开放平台后，选择机器人标签页，创建机器人。 录入相应配置信息，点击确认提交。 点击机器人进入详情页。 点击管理开发管理，获取AppID、AppSecret等信息，记录下来。 3、沙箱配置。 进入开发沙箱配置，在消息列表配置，点击添加成员，添加自己的账号，选择单独聊天。 说明 此处已创建的QQ机器人无需进行发布上架对所有QQ用户公开使用，在开发者私人的（沙箱）调试下使用体验即可。 QQ开放平台目前不支持机器人“在QQ群配置”操作，只支持单独和QQ机器人聊天。 添加成员后，通过该成员的QQ扫码来添加机器人。

本文介绍如何使用ECX部署OpenClaw QQ机器人。 注意 配置QQ机器人之前，请先确保已经购买ECX虚拟机并配置大模型服务。具体操作步骤，可参考指引：使用ECX部署OpenClaw。 创建QQ机器人并获取配置 1、注册QQ开放平台账号：登录++QQ开放平台++，默认无法使用个人QQ账号直接登录，需要新注册（可使用您的个人QQ账号申请主体类型为个人的开发者账号）。 说明 您也可以通过QQ开放平台龙虾专用入口快速创建机器人。 对应页面及链接由外部平台提供，可能随时更新，请留意链接有效性、检查域名真实性，谨防访问假冒网站上当受骗。 2、创建机器人。 成功登录QQ开放平台后，选择机器人标签页，创建机器人。 录入相应配置信息，点击确认提交。 点击机器人进入详情页。 点击管理开发管理，获取AppID、AppSecret等信息，记录下来。 3、沙箱配置。 进入开发沙箱配置，在消息列表配置，点击添加成员，添加自己的账号，选择单独聊天。 说明 此处已创建的QQ机器人无需进行发布上架对所有QQ用户公开使用，在开发者私人的（沙箱）调试下使用体验即可。 QQ开放平台目前不支持机器人“在QQ群配置”操作，只支持单独和QQ机器人聊天。 添加成员后，通过该成员的QQ扫码来添加机器人。

参数 参数类型 说明 示例 下级对象 statusCode Integer 响应状态码。 200 error String 错误码，执行成功时，不返回该字段。 VSS0001 message String 响应信息。 请求成功 requestId String 请求ID。 362d4e78556b47129182d0881fade86b returnObj Object 响应数据，执行失败时，不返回该字段。 returnObj

参数 是否必填 参数类型 说明 示例 下级对象 DeviceId 是 String 设备ID。 719340484461969408

参数 参数类型 说明 示例 下级对象 RequestId String 请求ID。 362d4e78556b47129182d0881fade86b

接口功能介绍 本接口用于修改回调模板。 接口约束 1. 修改模板前确保存在该回调模板。 2. url会进行批量修改，未传参的url将被置空。 请求参数说明： String类型的参数，传""等同于不传。 Integer类型的参数，传0等同于不传。 Boolean类型的参数，传false等同于不传。 URI PUT /v2/callbackTemplate/ 路径参数 参数 是否必填 参数类型 说明 示例 下级对象 TemplateId 是 String 模板ID。 739943519892963328 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 Description 否 String 模板描述，长度小于等于256个字符。 回调模板 CallbackKey 是 String 回调Key。 abc123 DeviceStatusNotifyUrl 否 String 设备状态回调URL。DeviceStatusNotifyUrl，StreamStatusNotifyUrl，RecordNotifyUrl，SnapshotNotifyUrl，AiEventNotifyUrl至少选择一种。 < StreamStatusNotifyUrl 否 String 流状态回调URL。DeviceStatusNotifyUrl，StreamStatusNotifyUrl，RecordNotifyUrl，SnapshotNotifyUrl，AiEventNotifyUrl至少选择一种。 < RecordNotifyUrl 否 String 录制回调URL。DeviceStatusNotifyUrl，StreamStatusNotifyUrl，RecordNotifyUrl，SnapshotNotifyUrl，AiEventNotifyUrl至少选择一种。 < AiEventNotifyUrl 否 String AI回调URL。DeviceStatusNotifyUrl，StreamStatusNotifyUrl，RecordNotifyUrl，SnapshotNotifyUrl，AiEventNotifyUrl至少选择一种。 <

参数 参数类型 说明 示例 下级对象 statusCode Integer 响应状态码。 200 error String 错误码，执行成功时，不返回该字段。 VSS0001 message String 响应信息。 请求成功 requestId String 请求ID。 362d4e78556b47129182d0881fade86b returnObj Object 响应数据，执行失败时，不返回该字段。 returnObj

参数 是否必填 参数类型 说明 示例 下级对象 SortBy 否 String 选择按一个字段排序，默认为CreatedTime，按照创建时间排序。取值：CreatedTime：创建时间；UpdatedTime：更新时间； CreatedTime SortDirection 否 String 排序方式，默认升序。取值：asc：升序；desc：降序。 asc PageNum 否 Integer 第几个分页，默认为1。 1 PageSize 否 Integer 分页大小，默认为20，取值范围为1～1000。 20

参数 是否必填 参数类型 说明 示例 下级对象 RecordTemplateId 是 String 模板id 717074786139029504

参数 是否必填 参数类型 说明 示例 下级对象 DeviceId 是 String 设备ID。 752657499261403136

枚举参数 无 请求示例 请求url GET '/v2/gb28181Certs?PageNum1&PageSize20' 请求头header 无 请求体body 无 响应示例 {"statusCode": 200,"message": "请求成功","requestId": "bed9f443d64e4361ad272860d4ab67ca","returnObj": {"PageNum": 1,"PageSize": 20,"TotalPage": 1,"TotalNum": 1,"gb28181Certs": [{"UserName": "test","UserType": "normal","Description": "","CreatedTime": "20220922093159","UpdatedTime": "20221021150614"}],"RequestId": "bed9f443d64e4361ad272860d4ab67ca"}} 状态码 请参考 状态码 错误码 请参考 错误码

枚举参数 无 请求示例 请求url PUT '/v2/devices/32388487739092996/records/stopCloudRecord' 请求头header 无 请求体body 无 响应示例 {"statusCode": 200,"message": "请求成功","requestId": "716580ae4fe14821b9cfdad0066c2649","returnObj": {"CreatedTime": "20230506 15:29:18","UpdatedTime": "20230506 16:02:34","RequestId": "716580ae4fe14821b9cfdad0066c2649"}} 状态码 请参考 状态码 错误码 请参考 错误码

接口功能介绍 本接口用于创建GB28181凭证，该凭证用于GB28181设备注册。 接口约束 创建的凭证名称请勿重复。 请求参数说明： String类型的参数，传""等同于不传。 Integer类型的参数，传0等同于不传。 Boolean类型的参数，传false等同于不传。 URI POST /v2/gb28181Certs 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 UserName 是 String 凭证用户名，长度164位，仅支持输入小写字母和数字。 cert Password 是 String 凭证密码，凭证密码长度为8位～32位的字符串，至少包含以下三种字符：大写字母、小写字母、数字和特殊字符（@ ）。 qwER1234 Description 否 String 凭证描述。 cert 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 响应状态码。 200 error String 错误码，执行成功时，不返回该字段。 VSS0001 message String 响应信息。 请求成功 requestId String 请求ID。 362d4e78556b47129182d0881fade86b returnObj Object 响应数据，执行失败时，不返回该字段。 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 UserName String 凭证用户名。 cert UserType String 凭证类型。 normal Description String 凭证描述。 描述 CreatedTime String 凭证创建时间。 1681370054428110 UpdatedTime String 凭证更新时间。 1681370054428110 RequestId String 请求ID。 64c9f09a7d434519abbcdd5e20620732

参数 是否必填 参数类型 说明 示例 下级对象 DeviceId 是 String 设备ID。 752657499261403136

参数 参数类型 说明 示例 下级对象 statusCode Integer 响应状态码。 200 error String 错误码，执行成功时，不返回该字段。 VSS0001 message String 响应信息。 请求成功 requestId String 请求ID。 362d4e78556b47129182d0881fade86b returnObj Object 响应数据，执行失败时，不返回该字段。 returnObj

参数 是否必填 参数类型 说明 示例 下级对象 UserName 是 String 凭证用户名。 cert

参数 参数类型 说明 示例 下级对象 DeviceId String 设备ID。 752657499261403136 RequestId String 请求ID。 20be6a0c4b0f42a288fb563c561d0a4c

参数 参数类型 说明 示例 下级对象 statusCode Integer 响应状态码。 200 error String 错误码，执行成功时，不返回该字段。 VSS0001 message String 响应信息。 请求成功 requestId String 请求ID。 362d4e78556b47129182d0881fade86b returnObj Object 响应数据，执行失败时，不返回该字段。 returnObj

参数 是否必填 参数类型 说明 示例 下级对象 DeviceId 是 String 设备ID。 717793119419891712 RecordTemplateId 是 String 录制模板ID。 717074786139029504

接口功能介绍 本接口用于绑定视频存储模板至设备。 接口约束 仅设备的计费模式为按需时，可以手动绑定存储模板至设备。 请求参数说明： String类型的参数，传""等同于不传。 Integer类型的参数，传0等同于不传。 Boolean类型的参数，传false等同于不传。 URI PUT /v2/devices//recordTemplate/ 路径参数 参数 是否必填 参数类型 说明 示例 下级对象 DeviceId 是 String 设备ID。 717793119419891712 RecordTemplateId 是 String 录制模板ID，如果已经绑定过录制模板则会覆盖旧的录制模板。 717074786139029504 Query参数 无 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 响应状态码。 200 error String 错误码，执行成功时，不返回该字段。 VSS0001 message String 响应信息。 请求成功 requestId String 请求ID。 362d4e78556b47129182d0881fade86b returnObj Object 响应数据，执行失败时，不返回该字段。 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 CreatedTime String 绑定关系创建时间。 20230426 15:02:37 UpdatedTime String 绑定关系更新时间。 20230426 15:02:37 RequestId String 请求ID。 7069f32f16034c3e95988c0c30c04762

参数 参数类型 说明 示例 下级对象 statusCode Integer 响应状态码。 200 error String 错误码，执行成功时，不返回该字段。 VSS0001 message String 响应信息。 请求成功 requestId String 请求ID。 362d4e78556b47129182d0881fade86b returnObj Object 响应数据，执行失败时，不返回该字段。 returnObj

参数 参数类型 说明 示例 下级对象 PageNum Integer 第几个分页。 1 PageSize Integer 分页大小。 10 TotalPage Integer 分页总数。 1 TotalNum Integer 模板总数。 10 CallbackTemplates Array of Objects 模板列表。 CallbackTemplate RequestId String 请求ID。 362d4e78556b47129182d0881fade86b

参数 参数类型 说明 示例 下级对象 RequestId String 请求ID。 68561b784a2944a7a713186f5cb20d34

接口功能介绍 本接口用于创建视频存储模板，支持配置录制类型、存储时长等。 接口约束 请求参数说明： String类型的参数，传""等同于不传。 Integer类型的参数，传0等同于不传。 Boolean类型的参数，传false等同于不传。 URI POST /v2/recordTemplates 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 TemplateName 是 String 模板名称，464位，可包含大小写字母、数字、中文、中划线、下划线、小括号、空格。 存储模板 FileFormat 否 String 录像文件格式，默认m3u8。取值：m3u8：符合hls协议的m3u8文件；ps：符合国标协议的ps文件。 m3u8 FileDuration 否 Integer 录像单文件时长，单位秒。 1800 RecordModes 是 Array of Objects 录制方式列表，可以配置多种录制类型。 RecordMode Description 否 String 模板描述，长度小于等于255个字符。 描述 表 RecordMode 参数 是否必填 参数类型 说明 示例 下级对象 RecordType 是 Integer 录制类型。取值：1：全天录制；2：循环定时录制；3：指定时间录制；5：手动录制。 1 StorageTime 是 Integer 存储时长，单位秒，最小不少于30天。例：2592000表示30天。 2592000 WeekTimeSections 否 Array of Objects 定时录制的时间段，当RecordType为2时，该字段必选。 WeekTimeSection SpecTimeSections 否 Array of Objects 指定时间录制的时间段，当RecordType为3时，该字段必选。 SpecTimeSection 表 WeekTimeSection 参数 是否必填 参数类型 说明 示例 下级对象 DayofWeek 是 Integer 日期。取值：1~~7（对应周一~~周日）。 1 StartTime 是 String 录制开始时间，格式：HH:mm:ss，范围：[00:00:00~23:59:59]。 00:02:00 EndTime 是 String 录制结束时间，格式：HH:mm:ss，范围：[00:00:00~23:59:59]。 00:05:00 表 SpecTimeSection 参数 是否必填 参数类型 说明 示例 下级对象 StartTime 是 String 录制开始时间，格式：YYYYDDMM HH:mm:ss。 20211125 00:02:00 EndTime 是 String 录制结束时间，格式：YYYYDDMM HH:mm:ss。 20211126 00:05:00