AS AgentScopeAPI 手册 / API Reference
类class io.agentscope.runtime.sandbox.manager legacy

SandboxManager

public class SandboxManager implements AutoCloseable
源码Source io/agentscope/runtime/sandbox/manager/SandboxManager.java:43–1179

沙箱管理器，承载智能体的部署、调度与服务化运行。位于 io.agentscope.runtime.sandbox.manager 包，实现 AutoCloseable。核心成员包括 getAgentBayClient、start、createFromPool、createContainer、getSandbox、startSandbox。

Sandbox Manager for managing container lifecycle

构造器摘要Constructor Summary

构造器Constructor说明Description
public SandboxManager()
初始化 `SandboxManager` 实例。
Creates a new instance.
public SandboxManager(String baseUrl, String bearerToken)
初始化 `SandboxManager` 实例。
Creates a new instance.
public SandboxManager(ManagerConfig managerConfig)
初始化 `SandboxManager` 实例。
Creates a new instance.
public SandboxManager(ManagerConfig managerConfig, String baseUrl, String bearerToken)
初始化 `SandboxManager` 实例。
Creates a new instance.

方法摘要Method Summary

方法Method说明Description
public AgentBayClient getAgentBayClient()
获取 `getAgentBayClient`。
Returns the agent bay client.
public void start()
执行启动相关操作。
Returns the start.
public ContainerModel createFromPool(SandboxType sandboxType, String imageId, Map<String, String> labels)
创建来自连接池。
Creates the from pool.
public ContainerModel createFromPool(SandboxType sandboxType, String userID, String sessionID)
创建来自连接池。
Creates the from pool.
public ContainerModel createFromPool(SandboxType sandboxType, String userID, String sessionID, String imageId, Map<String, String> labels)
创建来自连接池。
Creates the from pool.
public ContainerModel createContainer(SandboxType sandboxType)
创建容器。
Creates the container.
public ContainerModel createContainer(SandboxType sandboxType, String mountDir, String storagePath, Map<String, String> environment)
创建容器。
Creates the container.
public ContainerModel createContainer(SandboxType sandboxType, String mountDir, String storagePath, Map<String, String> environment, String imageId, Map<String, String> labels)
创建容器。
Creates the container.
public ContainerModel getSandbox(SandboxType sandboxType, String userID, String sessionID)
获取沙箱。
Returns the sandbox.
public ContainerModel getSandbox(SandboxType sandboxType, String userID, String sessionID, String imageId, Map<String, String> labels)
获取沙箱。
Returns the sandbox.
public ContainerModel getSandbox(SandboxType sandboxType, String mountDir, String storagePath, Map<String, String> environment, String userID, String sessionID)
获取沙箱。
Returns the sandbox.
public ContainerModel getSandbox(SandboxType sandboxType, String mountDir, String storagePath, Map<String, String> environment, String userID, String sessionID, String imageId, Map<String, String> labels)
获取沙箱。
Returns the sandbox.
public void startSandbox(SandboxType sandboxType, String userID, String sessionID)
启动沙箱。
Starts the sandbox.
public void stopSandbox(SandboxType sandboxType, String userID, String sessionID)
停止沙箱。
Stops the sandbox.
public void removeSandbox(SandboxType sandboxType, String userID, String sessionID)
移除沙箱。
Removes the sandbox.
public void stopAndRemoveSandbox(SandboxType sandboxType, String userID, String sessionID)
停止和移除沙箱。
Stops the and remove sandbox.
public String getSandboxStatus(SandboxType sandboxType, String userID, String sessionID)
获取沙箱状态。
Returns the sandbox status.
public Map<SandboxKey, ContainerModel> getAllSandboxes()
获取 `getAllSandboxes`。
Returns the all sandboxes.
public ContainerModel getInfo(String identity)
获取信息。
Returns the info.
public boolean release(String identity)
关闭资源并释放连接。
Releases resources and connections.
public ContainerManagerType getContainerManagerType()
获取容器管理器类型。
Returns the container manager type.
public ManagerConfig getManagerConfig()
获取管理器配置。
Returns the manager config.
public BaseClient getContainerClient()
获取容器客户端。
Returns the container client.
public StorageManager getStorageManager()
获取存储管理器。
Returns the storage manager.
public RemoteHttpClient getRemoteHttpClient()
获取远程 HTTP 客户端。
Returns the remote http client.
public void cleanupAllSandboxes()
执行 `cleanupAllSandboxes` 方法。
Returns the cleanup all sandboxes.
public void close()
关闭连接并释放相关资源。
Releases resources and connections.
public String listTools(String identity, String toolType)
列出工具。
Lists the tools.
public Map<String, Object> listTools(String sandboxId, String userId, String sessionId, String toolType)
列出工具。
Lists the tools.
public String callTool(String sandboxId, String userId, String sessionId, String toolName, Map<String, Object> arguments)
调用工具。
Calls the tool.
public Map<String, Object> addMcpServers(String sandboxId, String userId, String sessionId, Map<String, Object> serverConfigs, boolean overwrite)
添加 `addMcpServers`。
Adds the mcp servers.
public boolean releaseSandbox(SandboxType sandboxType, String userId, String sessionId)
执行 `releaseSandbox` 方法。
Performs the release sandbox operation.

构造器详情Constructor Detail

SandboxManager

public SandboxManager()

初始化 SandboxManager 实例。

Creates a new instance.

源码Source io/agentscope/runtime/sandbox/manager/SandboxManager.java:65–67

SandboxManager

public SandboxManager(String baseUrl, String bearerToken)

初始化 SandboxManager 实例。

Creates a new instance.

参数Parameters
名称Name类型Type说明Description
baseUrlString基类 URL（类型 `String`）。The base url.
bearerTokenStringbearer 令牌（类型 `String`）。The bearer token.
源码Source io/agentscope/runtime/sandbox/manager/SandboxManager.java:69–71

SandboxManager

public SandboxManager(ManagerConfig managerConfig)

初始化 SandboxManager 实例。

Creates a new instance.

参数Parameters
名称Name类型Type说明Description
managerConfigManagerConfig管理器配置（类型 `ManagerConfig`）。The manager config.
源码Source io/agentscope/runtime/sandbox/manager/SandboxManager.java:73–75

SandboxManager

public SandboxManager(ManagerConfig managerConfig, String baseUrl, String bearerToken)

初始化 SandboxManager 实例。

Creates a new instance.

参数Parameters
名称Name类型Type说明Description
managerConfigManagerConfig管理器配置（类型 `ManagerConfig`）。The manager config.
baseUrlString基类 URL（类型 `String`）。The base url.
bearerTokenStringbearer 令牌（类型 `String`）。The bearer token.
源码Source io/agentscope/runtime/sandbox/manager/SandboxManager.java:77–104

方法详情Method Detail

getAgentBayClient

public AgentBayClient getAgentBayClient()

获取 getAgentBayClient。

Returns the agent bay client.

返回Returns AgentBayClient
返回AgentBayClient。Returns agent bay client.
源码Source io/agentscope/runtime/sandbox/manager/SandboxManager.java:60–62

start

public void start()

执行启动相关操作。

Returns the start.

源码Source io/agentscope/runtime/sandbox/manager/SandboxManager.java:106–179

createFromPool

public ContainerModel createFromPool(SandboxType sandboxType, String imageId, Map<String, String> labels)

创建来自连接池。

Creates the from pool.

参数Parameters
名称Name类型Type说明Description
sandboxTypeSandboxType沙箱类型（类型 `SandboxType`）。The sandbox type.
imageIdString图像标识（类型 `String`）。The image id.
labelsMap<String, String>labels（类型 `Map`）。The labels.
返回Returns ContainerModel
返回ContainerModel。Returns container model.
源码Source io/agentscope/runtime/sandbox/manager/SandboxManager.java:244–297

createFromPool

public ContainerModel createFromPool(SandboxType sandboxType, String userID, String sessionID)

创建来自连接池。

Creates the from pool.

参数Parameters
名称Name类型Type说明Description
sandboxTypeSandboxType沙箱类型（类型 `SandboxType`）。The sandbox type.
userIDString用户标识（类型 `String`）。The user ID.
sessionIDString会话标识（类型 `String`）。The session ID.
返回Returns ContainerModel
返回ContainerModel。Returns container model.
源码Source io/agentscope/runtime/sandbox/manager/SandboxManager.java:299–301

createFromPool

public ContainerModel createFromPool(SandboxType sandboxType, String userID, String sessionID, String imageId, Map<String, String> labels)

创建来自连接池。

Creates the from pool.

参数Parameters
名称Name类型Type说明Description
sandboxTypeSandboxType沙箱类型（类型 `SandboxType`）。The sandbox type.
userIDString用户标识（类型 `String`）。The user ID.
sessionIDString会话标识（类型 `String`）。The session ID.
imageIdString图像标识（类型 `String`）。The image id.
labelsMap<String, String>labels（类型 `Map`）。The labels.
返回Returns ContainerModel
返回ContainerModel。Returns container model.
源码Source io/agentscope/runtime/sandbox/manager/SandboxManager.java:303–363

createContainer

public ContainerModel createContainer(SandboxType sandboxType)

创建容器。

Creates the container.

参数Parameters
名称Name类型Type说明Description
sandboxTypeSandboxType沙箱类型（类型 `SandboxType`）。The sandbox type.
返回Returns ContainerModel
返回ContainerModel。Returns container model.
源码Source io/agentscope/runtime/sandbox/manager/SandboxManager.java:365–367

createContainer

public ContainerModel createContainer(SandboxType sandboxType, String mountDir, String storagePath, Map<String, String> environment)

创建容器。

Creates the container.

参数Parameters
名称Name类型Type说明Description
sandboxTypeSandboxType沙箱类型（类型 `SandboxType`）。The sandbox type.
mountDirStringmount 目录（类型 `String`）。The mount dir.
storagePathString存储路径（类型 `String`）。The storage path.
environmentMap<String, String>环境（类型 `Map`）。The environment.
返回Returns ContainerModel
返回ContainerModel。Returns container model.
源码Source io/agentscope/runtime/sandbox/manager/SandboxManager.java:369–371

createContainer

public ContainerModel createContainer(SandboxType sandboxType, String mountDir, String storagePath, Map<String, String> environment, String imageId, Map<String, String> labels)

创建容器。

Creates the container.

参数Parameters
名称Name类型Type说明Description
sandboxTypeSandboxType沙箱类型（类型 `SandboxType`）。The sandbox type.
mountDirStringmount 目录（类型 `String`）。The mount dir.
storagePathString存储路径（类型 `String`）。The storage path.
environmentMap<String, String>环境（类型 `Map`）。The environment.
imageIdString图像标识（类型 `String`）。The image id.
labelsMap<String, String>labels（类型 `Map`）。The labels.
返回Returns ContainerModel
返回ContainerModel。Returns container model.
源码Source io/agentscope/runtime/sandbox/manager/SandboxManager.java:373–599

getSandbox

public ContainerModel getSandbox(SandboxType sandboxType, String userID, String sessionID)

获取沙箱。

Returns the sandbox.

参数Parameters
名称Name类型Type说明Description
sandboxTypeSandboxType沙箱类型（类型 `SandboxType`）。The sandbox type.
userIDString用户标识（类型 `String`）。The user ID.
sessionIDString会话标识（类型 `String`）。The session ID.
返回Returns ContainerModel
返回ContainerModel。Returns container model.
源码Source io/agentscope/runtime/sandbox/manager/SandboxManager.java:618–620

getSandbox

public ContainerModel getSandbox(SandboxType sandboxType, String userID, String sessionID, String imageId, Map<String, String> labels)

获取沙箱。

Returns the sandbox.

参数Parameters
名称Name类型Type说明Description
sandboxTypeSandboxType沙箱类型（类型 `SandboxType`）。The sandbox type.
userIDString用户标识（类型 `String`）。The user ID.
sessionIDString会话标识（类型 `String`）。The session ID.
imageIdString图像标识（类型 `String`）。The image id.
labelsMap<String, String>labels（类型 `Map`）。The labels.
返回Returns ContainerModel
返回ContainerModel。Returns container model.
源码Source io/agentscope/runtime/sandbox/manager/SandboxManager.java:622–624

getSandbox

public ContainerModel getSandbox(SandboxType sandboxType, String mountDir, String storagePath, Map<String, String> environment, String userID, String sessionID)

获取沙箱。

Returns the sandbox.

参数Parameters
名称Name类型Type说明Description
sandboxTypeSandboxType沙箱类型（类型 `SandboxType`）。The sandbox type.
mountDirStringmount 目录（类型 `String`）。The mount dir.
storagePathString存储路径（类型 `String`）。The storage path.
environmentMap<String, String>环境（类型 `Map`）。The environment.
userIDString用户标识（类型 `String`）。The user ID.
sessionIDString会话标识（类型 `String`）。The session ID.
返回Returns ContainerModel
返回ContainerModel。Returns container model.
源码Source io/agentscope/runtime/sandbox/manager/SandboxManager.java:626–628

getSandbox

public ContainerModel getSandbox(SandboxType sandboxType, String mountDir, String storagePath, Map<String, String> environment, String userID, String sessionID, String imageId, Map<String, String> labels)

获取沙箱。

Returns the sandbox.

参数Parameters
名称Name类型Type说明Description
sandboxTypeSandboxType沙箱类型（类型 `SandboxType`）。The sandbox type.
mountDirStringmount 目录（类型 `String`）。The mount dir.
storagePathString存储路径（类型 `String`）。The storage path.
environmentMap<String, String>环境（类型 `Map`）。The environment.
userIDString用户标识（类型 `String`）。The user ID.
sessionIDString会话标识（类型 `String`）。The session ID.
imageIdString图像标识（类型 `String`）。The image id.
labelsMap<String, String>labels（类型 `Map`）。The labels.
返回Returns ContainerModel
返回ContainerModel。Returns container model.
源码Source io/agentscope/runtime/sandbox/manager/SandboxManager.java:630–657

startSandbox

public void startSandbox(SandboxType sandboxType, String userID, String sessionID)

启动沙箱。

Starts the sandbox.

参数Parameters
名称Name类型Type说明Description
sandboxTypeSandboxType沙箱类型（类型 `SandboxType`）。The sandbox type.
userIDString用户标识（类型 `String`）。The user ID.
sessionIDString会话标识（类型 `String`）。The session ID.
源码Source io/agentscope/runtime/sandbox/manager/SandboxManager.java:659–692

stopSandbox

public void stopSandbox(SandboxType sandboxType, String userID, String sessionID)

停止沙箱。

Stops the sandbox.

参数Parameters
名称Name类型Type说明Description
sandboxTypeSandboxType沙箱类型（类型 `SandboxType`）。The sandbox type.
userIDString用户标识（类型 `String`）。The user ID.
sessionIDString会话标识（类型 `String`）。The session ID.
源码Source io/agentscope/runtime/sandbox/manager/SandboxManager.java:694–727

removeSandbox

public void removeSandbox(SandboxType sandboxType, String userID, String sessionID)

移除沙箱。

Removes the sandbox.

参数Parameters
名称Name类型Type说明Description
sandboxTypeSandboxType沙箱类型（类型 `SandboxType`）。The sandbox type.
userIDString用户标识（类型 `String`）。The user ID.
sessionIDString会话标识（类型 `String`）。The session ID.
源码Source io/agentscope/runtime/sandbox/manager/SandboxManager.java:729–746

stopAndRemoveSandbox

public void stopAndRemoveSandbox(SandboxType sandboxType, String userID, String sessionID)

停止和移除沙箱。

Stops the and remove sandbox.

参数Parameters
名称Name类型Type说明Description
sandboxTypeSandboxType沙箱类型（类型 `SandboxType`）。The sandbox type.
userIDString用户标识（类型 `String`）。The user ID.
sessionIDString会话标识（类型 `String`）。The session ID.
源码Source io/agentscope/runtime/sandbox/manager/SandboxManager.java:748–787

getSandboxStatus

public String getSandboxStatus(SandboxType sandboxType, String userID, String sessionID)

获取沙箱状态。

Returns the sandbox status.

参数Parameters
名称Name类型Type说明Description
sandboxTypeSandboxType沙箱类型（类型 `SandboxType`）。The sandbox type.
userIDString用户标识（类型 `String`）。The user ID.
sessionIDString会话标识（类型 `String`）。The session ID.
返回Returns String
返回字符串结果。Returns a string.
源码Source io/agentscope/runtime/sandbox/manager/SandboxManager.java:789–820

getAllSandboxes

public Map<SandboxKey, ContainerModel> getAllSandboxes()

获取 getAllSandboxes。

Returns the all sandboxes.

返回Returns Map<SandboxKey, ContainerModel>
返回映射。Returns map.
源码Source io/agentscope/runtime/sandbox/manager/SandboxManager.java:822–837

getInfo

public ContainerModel getInfo(String identity)

获取信息。

Returns the info.

参数Parameters
名称Name类型Type说明Description
identityString身份（类型 `String`）。The identity.
返回Returns ContainerModel
返回ContainerModel。Returns container model.
源码Source io/agentscope/runtime/sandbox/manager/SandboxManager.java:839–892

release

public boolean release(String identity)

关闭资源并释放连接。

Releases resources and connections.

参数Parameters
名称Name类型Type说明Description
identityString身份（类型 `String`）。The identity.
返回Returns boolean
返回布尔值，表示判断结果。Returns a boolean result.
源码Source io/agentscope/runtime/sandbox/manager/SandboxManager.java:895–967

getContainerManagerType

public ContainerManagerType getContainerManagerType()

获取容器管理器类型。

Returns the container manager type.

返回Returns ContainerManagerType
返回ContainerManagerType。Returns container manager type.
源码Source io/agentscope/runtime/sandbox/manager/SandboxManager.java:969–971

getManagerConfig

public ManagerConfig getManagerConfig()

获取管理器配置。

Returns the manager config.

返回Returns ManagerConfig
返回ManagerConfig。Returns manager config.
源码Source io/agentscope/runtime/sandbox/manager/SandboxManager.java:973–975

getContainerClient

public BaseClient getContainerClient()

获取容器客户端。

Returns the container client.

返回Returns BaseClient
返回BaseClient。Returns base client.
源码Source io/agentscope/runtime/sandbox/manager/SandboxManager.java:977–979

getStorageManager

public StorageManager getStorageManager()

获取存储管理器。

Returns the storage manager.

返回Returns StorageManager
返回StorageManager。Returns storage manager.
源码Source io/agentscope/runtime/sandbox/manager/SandboxManager.java:981–983

getRemoteHttpClient

public RemoteHttpClient getRemoteHttpClient()

获取远程 HTTP 客户端。

Returns the remote http client.

返回Returns RemoteHttpClient
返回RemoteHttpClient。Returns remote http client.
源码Source io/agentscope/runtime/sandbox/manager/SandboxManager.java:985–987

cleanupAllSandboxes

public void cleanupAllSandboxes()

执行 cleanupAllSandboxes 方法。

Returns the cleanup all sandboxes.

源码Source io/agentscope/runtime/sandbox/manager/SandboxManager.java:989–1033

close

public void close()

关闭连接并释放相关资源。

Releases resources and connections.

源码Source io/agentscope/runtime/sandbox/manager/SandboxManager.java:1035–1059

listTools

public String listTools(String identity, String toolType)

列出工具。

Lists the tools.

参数Parameters
名称Name类型Type说明Description
identityString身份（类型 `String`）。The identity.
toolTypeString工具类型（类型 `String`）。The tool type.
返回Returns String
返回字符串结果。Returns a string.
源码Source io/agentscope/runtime/sandbox/manager/SandboxManager.java:1061–1063

listTools

public Map<String, Object> listTools(String sandboxId, String userId, String sessionId, String toolType)

列出工具。

Lists the tools.

参数Parameters
名称Name类型Type说明Description
sandboxIdString沙箱标识（类型 `String`）。The sandbox id.
userIdString用户标识（类型 `String`）。The user id.
sessionIdString会话标识（类型 `String`）。The session id.
toolTypeString工具类型（类型 `String`）。The tool type.
返回Returns Map<String, Object>
返回映射。Returns map.
源码Source io/agentscope/runtime/sandbox/manager/SandboxManager.java:1078–1107

callTool

public String callTool(String sandboxId, String userId, String sessionId, String toolName, Map<String, Object> arguments)

调用工具。

Calls the tool.

参数Parameters
名称Name类型Type说明Description
sandboxIdString沙箱标识（类型 `String`）。The sandbox id.
userIdString用户标识（类型 `String`）。The user id.
sessionIdString会话标识（类型 `String`）。The session id.
toolNameString工具名称（类型 `String`）。The tool name.
argumentsMap<String, Object>参数（类型 `Map`）。The arguments.
返回Returns String
返回字符串结果。Returns a string.
源码Source io/agentscope/runtime/sandbox/manager/SandboxManager.java:1109–1135

addMcpServers

public Map<String, Object> addMcpServers(String sandboxId, String userId, String sessionId, Map<String, Object> serverConfigs, boolean overwrite)

添加 addMcpServers。

Adds the mcp servers.

参数Parameters
名称Name类型Type说明Description
sandboxIdString沙箱标识（类型 `String`）。The sandbox id.
userIdString用户标识（类型 `String`）。The user id.
sessionIdString会话标识（类型 `String`）。The session id.
serverConfigsMap<String, Object>服务端 Configs（类型 `Map`）。The server configs.
overwritebooleanoverwrite（类型 `boolean`）。The overwrite.
返回Returns Map<String, Object>
返回映射。Returns map.
源码Source io/agentscope/runtime/sandbox/manager/SandboxManager.java:1137–1167

releaseSandbox

public boolean releaseSandbox(SandboxType sandboxType, String userId, String sessionId)

执行 releaseSandbox 方法。

Performs the release sandbox operation.

参数Parameters
名称Name类型Type说明Description
sandboxTypeSandboxType沙箱类型（类型 `SandboxType`）。The sandbox type.
userIdString用户标识（类型 `String`）。The user id.
sessionIdString会话标识（类型 `String`）。The session id.
返回Returns boolean
返回布尔值，表示判断结果。Returns a boolean result.
源码Source io/agentscope/runtime/sandbox/manager/SandboxManager.java:1169–1178
基于官方固定版本源码静态生成Generated from pinned official sources · Python 2.0.11 · Java 2.0.4
签名与文档为静态抽取；如有疑问请以源码为准。Signatures and docs are extracted statically; verify against the source when in doubt.