AS AgentScopeAPI 手册 / API Reference

AgentRunSandbox

public class AgentRunSandbox extends AbstractBaseSandbox
源码Source io/agentscope/extensions/sandbox/agentrun/AgentRunSandbox.java:39–268

智能体运行沙箱,在隔离环境中安全执行代码和工具。位于 io.agentscope.extensions.sandbox.agentrun 包,继承自 AbstractBaseSandbox。核心成员包括 start、stop、shutdown、probeWorkspaceRootForPreservedResume、doExec、doPersistWorkspace。

io.agentscope.harness.agent.sandbox.Sandbox backed by an Alibaba Cloud AgentRun sandbox (FC 3.0 Sandbox API 2025-09-10).

Execution runs over the AgentRun MCP server bundled with the sandbox template. When the sandbox state declares workspaceOnNas=true, persistence is delegated entirely to the NAS mount and #doPersistWorkspace() is a no-op; otherwise the sandbox falls back to a tar-via-MCP archive identical in shape to Daytona's payload.

构造器摘要Constructor Summary

构造器Constructor说明Description
public AgentRunSandbox(AgentRunSandboxState state, AgentRunSandboxClientOptions options, AgentRunDataPlaneHttp http, AgentRunMcpChannel mcp)
初始化 `AgentRunSandbox` 实例。
Creates a new instance.

方法摘要Method Summary

方法Method说明Description
public void start() throws Exception
执行启动相关操作。
Returns the start.
public void stop() throws Exception
执行停止相关操作。
Returns the stop.
public void shutdown() throws Exception
关闭资源并释放连接。
Releases resources and connections.
protected boolean probeWorkspaceRootForPreservedResume()
返回 `probeWorkspaceRootForPreservedResume` 结果。
Returns the probe workspace root for preserved resume.
protected ExecResult doExec(RuntimeContext runtimeContext, String command, int timeoutSeconds) throws Exception
执行 `doExec` 回调。
Performs the do exec operation.
protected InputStream doPersistWorkspace() throws Exception
执行 `doPersistWorkspace` 回调。
Returns the do persist workspace.
protected void doHydrateWorkspace(InputStream archive) throws Exception
执行 `doHydrateWorkspace` 回调。
Performs the do hydrate workspace operation.
protected void doSetupWorkspace() throws Exception
执行 `doSetupWorkspace` 回调。
Returns the do setup workspace.
protected void doDestroyWorkspace() throws Exception
执行 `doDestroyWorkspace` 回调。
Returns the do destroy workspace.
protected String getWorkspaceRoot()
获取工作区根。
Returns the workspace root.

构造器详情Constructor Detail

AgentRunSandbox

public AgentRunSandbox(AgentRunSandboxState state, AgentRunSandboxClientOptions options, AgentRunDataPlaneHttp http, AgentRunMcpChannel mcp)

初始化 AgentRunSandbox 实例。

Creates a new instance.

参数Parameters
名称Name类型Type说明Description
stateAgentRunSandboxState状态对象(类型 `AgentRunSandboxState`)。The state.
optionsAgentRunSandboxClientOptions选项(类型 `AgentRunSandboxClientOptions`)。The options.
httpAgentRunDataPlaneHttpHTTP(类型 `AgentRunDataPlaneHttp`)。The http.
mcpAgentRunMcpChannelMCP(类型 `AgentRunMcpChannel`)。The mcp.
源码Source io/agentscope/extensions/sandbox/agentrun/AgentRunSandbox.java:53–63

方法详情Method Detail

start

public void start() throws Exception

执行启动相关操作。

Returns the start.

抛出Throws
  • Exception 可能抛出 `Exception`。Thrown when the operation cannot be completed.
源码Source io/agentscope/extensions/sandbox/agentrun/AgentRunSandbox.java:65–75

stop

public void stop() throws Exception

执行停止相关操作。

Returns the stop.

抛出Throws
  • Exception 可能抛出 `Exception`。Thrown when the operation cannot be completed.
源码Source io/agentscope/extensions/sandbox/agentrun/AgentRunSandbox.java:77–87

shutdown

public void shutdown() throws Exception

关闭资源并释放连接。

Releases resources and connections.

抛出Throws
  • Exception 可能抛出 `Exception`。Thrown when the operation cannot be completed.
源码Source io/agentscope/extensions/sandbox/agentrun/AgentRunSandbox.java:89–105

probeWorkspaceRootForPreservedResume

protected boolean probeWorkspaceRootForPreservedResume()

返回 probeWorkspaceRootForPreservedResume 结果。

Returns the probe workspace root for preserved resume.

返回Returns boolean
返回布尔值,表示判断结果。Returns a boolean result.
源码Source io/agentscope/extensions/sandbox/agentrun/AgentRunSandbox.java:107–115

doExec

protected ExecResult doExec(RuntimeContext runtimeContext, String command, int timeoutSeconds) throws Exception

执行 doExec 回调。

Performs the do exec operation.

参数Parameters
名称Name类型Type说明Description
runtimeContextRuntimeContext运行时上下文(类型 `RuntimeContext`)。The runtime context.
commandString命令(类型 `String`)。The command.
timeoutSecondsint超时秒(类型 `int`)。The timeout seconds.
返回Returns ExecResult
返回ExecResult。Returns exec result.
抛出Throws
  • Exception 可能抛出 `Exception`。Thrown when the operation cannot be completed.
源码Source io/agentscope/extensions/sandbox/agentrun/AgentRunSandbox.java:117–132

doPersistWorkspace

protected InputStream doPersistWorkspace() throws Exception

执行 doPersistWorkspace 回调。

Returns the do persist workspace.

返回Returns InputStream
返回InputStream。Returns input stream.
抛出Throws
  • Exception 可能抛出 `Exception`。Thrown when the operation cannot be completed.
源码Source io/agentscope/extensions/sandbox/agentrun/AgentRunSandbox.java:134–151

doHydrateWorkspace

protected void doHydrateWorkspace(InputStream archive) throws Exception

执行 doHydrateWorkspace 回调。

Performs the do hydrate workspace operation.

参数Parameters
名称Name类型Type说明Description
archiveInputStream归档(类型 `InputStream`)。The archive.
抛出Throws
  • Exception 可能抛出 `Exception`。Thrown when the operation cannot be completed.
源码Source io/agentscope/extensions/sandbox/agentrun/AgentRunSandbox.java:153–188

doSetupWorkspace

protected void doSetupWorkspace() throws Exception

执行 doSetupWorkspace 回调。

Returns the do setup workspace.

抛出Throws
  • Exception 可能抛出 `Exception`。Thrown when the operation cannot be completed.
源码Source io/agentscope/extensions/sandbox/agentrun/AgentRunSandbox.java:190–193

doDestroyWorkspace

protected void doDestroyWorkspace() throws Exception

执行 doDestroyWorkspace 回调。

Returns the do destroy workspace.

抛出Throws
  • Exception 可能抛出 `Exception`。Thrown when the operation cannot be completed.
源码Source io/agentscope/extensions/sandbox/agentrun/AgentRunSandbox.java:195–206

getWorkspaceRoot

protected String getWorkspaceRoot()

获取工作区根。

Returns the workspace root.

返回Returns String
返回字符串结果。Returns a string.
源码Source io/agentscope/extensions/sandbox/agentrun/AgentRunSandbox.java:208–211

继承成员Inherited Members

基于官方固定版本源码静态生成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.