函数服务
函数服务
文档指南
请输入
- 文档首页
函数服务用户指南云沙箱沙箱应用E2B 兼容性说明
复制全文
下载 pdfE2B 兼容性说明
文档反馈
问问助手函数服务云沙箱在接口层兼容 E2B 协议，并支持向任意沙箱镜像动态注入 Envd 运行时，业务无需改造镜像即可直接使用 E2B 官方 SDK。本文为您介绍 veFaaS 云沙箱对 E2B 官方 SDK 的兼容范围。
背景信息
E2B 是面向 AI Agent 和大模型应用的代码执行沙箱协议，提供隔离的云端运行环境，让 Agent 可以安全地执行代码、运行终端命令、读写文件并访问容器内端口。E2B 的目标是把代码执行环境标准化，避免开发者为每个 Agent 场景单独设计一套容器调度、隔离和生命周期管理逻辑。
接入方式
兼容概览
能力模块 | 说明 |
沙箱实例生命周期管理，包括创建连接、暂停恢复、终止、超时设置及访问地址获取等。 | |
进程和命令管理，提供命令执行、进程管理、终端连接、输入和结束进程等能力。 | |
文件系统管理，提供文件读写、目录管理和文件信息查看等能力。 | |
代码解释器管理，提供代码执行、上下文创建和状态保持能力。 | |
模板管理，提供模板查询、列表、更新、删除和标签管理能力。 | |
存储卷管理，支持创建、连接、销毁、列表及信息查询。 |
兼容 API 详情
Sandbox
SDK 方法 | 说明 |
sandbox.connect() | 连接已有沙箱实例，已暂停则自动恢复。 |
Sandbox.list() | 列出沙箱实例。 |
sandbox.getInfo() | 获取沙箱实例详情。 |
sandbox.kill() | 终止沙箱实例。 |
sandbox.setTimeout() | 设置或刷新沙箱实例的存活时长。 |
sandbox.isRunning() | 沙箱实例是否处于运行状态。 |
sandbox.pause() | 暂停沙箱实例。 |
Sandbox.connect(sandboxId) | 连接已有沙箱实例，已暂停则自动恢复。 |
Sandbox.setTimeout(sandboxId, ms) | 通过沙箱实例 ID 刷新沙箱实例存活时长。 |
sandbox.getHost(port) | 通过端口获取沙箱实例的对外访问地址。 |
sandbox.downloadUrl(path) | 通过路径获取沙箱实例文件的预签名下载地址。 |
sandbox.uploadUrl(path) | 通过路径获取沙箱实例文件的预签名上传地址。 |
Commands
SDK 方法 | 说明 |
sandbox.commands.run() | 执行命令。 |
sandbox.commands.list() | 列出运行中进程。 |
sandbox.commands.connect() | 连接到已有进程。 |
sandbox.commands.sendStdin() | 发送输入，例如在终端输入文字。 |
sandbox.commands.kill() | 终止进程。 |
sandbox.pty.create() | 创建 PTY（Pseudo Terminal，伪终端）。 |
sandbox.pty.connect() | 连接到已有 PTY 会话。 |
sandbox.pty.sendInput() | 向 PTY 发送输入。 |
sandbox.pty.resize() | 调整 PTY 窗口大小。 |
sandbox.pty.kill() | 终止 PTY。 |
sandbox.commands.closeStdin() | 关闭命令的输入通道。 |
Filesystem
SDK 方法 | 说明 |
sandbox.files.read() | 读取文件。 |
sandbox.files.write() | 写入文件。 |
sandbox.files.list() | 列出目录内容。 |
sandbox.files.exists() | 判断文件是否存在。 |
sandbox.files.makeDir() | 创建目录。 |
sandbox.files.remove() | 删除文件。 |
sandbox.files.rename() | 重命名文件。 |
sandbox.files.watchDir() | 监听沙箱实例内某个目录中文件的变化。 |
sandbox.files.getInfo() | 获取文件信息。 |
sandbox.files.writeFiles() | 批量写入多个文件。 |
Code Interpreter
SDK 方法 | 说明 |
sandbox.runCode() | 运行代码。 |
sandbox.createContext() | 创建执行上下文。 |
Template
SDK 方法 | 说明 |
Template.assignTags() | 分配模板标签。 |
Template.getTags() | 查询模板标签。 |
Template.removeTags() | 删除模板标签。 |
Volume
SDK 方法 | 说明 |
Volume.create() | 创建存储卷。 |
Volume.connect() | 连接到已有存储卷。 |
Volume.destroy() | 销毁存储卷。 |
Volume.list() | 列出团队所有存储卷。 |
Volume.getInfo() | 获取存储卷信息。 |
最近更新时间：2026.08.24 10:38:31
这个页面对您有帮助吗？
有用
有用
无用
无用