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

DockerClient

public class DockerClient extends BaseClient
源码Source io/agentscope/runtime/sandbox/manager/client/container/docker/DockerClient.java:39–685

Docker 客户端，封装与远端服务的连接和调用。位于 io.agentscope.runtime.sandbox.manager.client.container.docker 包，继承自 BaseClient。核心成员包括 connect、isConnected、createContainer、startContainer、stopContainer、removeContainer。

A class in io.agentscope.runtime.sandbox.manager.client.container.docker that deploys, schedules and serves agents. Declared in io.agentscope.runtime.sandbox.manager.client.container.docker. Extends BaseClient.

构造器摘要Constructor Summary

构造器Constructor说明Description
public DockerClient()
初始化 `DockerClient` 实例。
Default constructor without configuration
public DockerClient(DockerClientStarter config)
初始化 `DockerClient` 实例。
Constructor with DockerClientConfig
public DockerClient(DockerClientStarter config, PortManager portManager)
初始化 `DockerClient` 实例。
Creates a new instance.

方法摘要Method Summary

方法Method说明Description
public boolean connect()
建立连接并完成初始化。
Returns the connect.
public boolean isConnected()
判断是否已连接。
Returns whether the connected.
public ContainerCreateResult createContainer(String containerName, String imageName, List<String> ports, List<VolumeBinding> volumeBindings, Map<String, String> environment, Map<String, Object> runtimeConfig)
创建容器。
Creates the container.
public void startContainer(String containerId)
启动容器。
Starts the container.
public void stopContainer(String containerId)
停止容器。
Stops the container.
public void removeContainer(String containerId)
移除容器。
Removes the container.
public String getContainerStatus(String containerId)
获取容器状态。
Returns the container status.
public CreateContainerResponse createContainers(com.github.dockerjava.api.DockerClient client, String containerName, String imageName, List<String> ports, Map<String, Integer> portMapping, List<VolumeBinding> volumeBindings, Map<String, String> environment, Map<String, Object> runtimeConfig)
创建 `createContainers`。
Create container (supports port mapping)
public void startContainer(com.github.dockerjava.api.DockerClient client, String containerId)
启动容器。
Start container
public void stopContainer(com.github.dockerjava.api.DockerClient client, String containerId)
停止容器。
Stop container
public void removeContainer(com.github.dockerjava.api.DockerClient client, String containerId)
移除容器。
Delete container
public String getContainerStatus(com.github.dockerjava.api.DockerClient client, String containerId)
获取容器状态。
Get container status
public void stopAndRemoveContainer(com.github.dockerjava.api.DockerClient client, String containerId)
停止和移除容器。
Stop and delete container
public boolean imageExists(String imageName)
设置该参数。
Performs the image exists operation.
public boolean pullImage(String imageName)
设置该参数。
Performs the pull image operation.
public boolean inspectContainer(String containerIdOrName)
设置该参数。
Performs the inspect container operation.
public boolean imageExists(com.github.dockerjava.api.DockerClient client, String imageName)
执行 `imageExists` 方法。
Check if image exists locally
public boolean pullImage(com.github.dockerjava.api.DockerClient client, String imageName)
执行 `pullImage` 方法。
Pull image from registry
public boolean containerNameExists(String containerName)
设置该参数。
Performs the container name exists operation.

构造器详情Constructor Detail

DockerClient

public DockerClient()

初始化 DockerClient 实例。

Default constructor without configuration

源码Source io/agentscope/runtime/sandbox/manager/client/container/docker/DockerClient.java:50–53

DockerClient

public DockerClient(DockerClientStarter config)

初始化 DockerClient 实例。

Constructor with DockerClientConfig

参数Parameters
名称Name类型Type说明Description
configDockerClientStarter配置对象（类型 `DockerClientStarter`）。The config.
源码Source io/agentscope/runtime/sandbox/manager/client/container/docker/DockerClient.java:58–60

DockerClient

public DockerClient(DockerClientStarter config, PortManager portManager)

初始化 DockerClient 实例。

Creates a new instance.

参数Parameters
名称Name类型Type说明Description
configDockerClientStarter配置对象（类型 `DockerClientStarter`）。The config.
portManagerPortManagerport 管理器（类型 `PortManager`）。The port manager.
源码Source io/agentscope/runtime/sandbox/manager/client/container/docker/DockerClient.java:62–65

方法详情Method Detail

connect

public boolean connect()

建立连接并完成初始化。

Returns the connect.

返回Returns boolean
返回布尔值，表示判断结果。Returns a boolean result.
源码Source io/agentscope/runtime/sandbox/manager/client/container/docker/DockerClient.java:67–79

isConnected

public boolean isConnected()

判断是否已连接。

Returns whether the connected.

返回Returns boolean
返回布尔值，表示判断结果。Returns a boolean result.
源码Source io/agentscope/runtime/sandbox/manager/client/container/docker/DockerClient.java:81–84

createContainer

public ContainerCreateResult createContainer(String containerName, String imageName, List<String> ports, List<VolumeBinding> volumeBindings, Map<String, String> environment, Map<String, Object> runtimeConfig)

创建容器。

Creates the container.

参数Parameters
名称Name类型Type说明Description
containerNameString容器名称（类型 `String`）。The container name.
imageNameString图像名称（类型 `String`）。The image name.
portsList<String>ports（类型 `List`）。The ports.
volumeBindingsList<VolumeBinding>volume Bindings（类型 `List`）。The volume bindings.
environmentMap<String, String>环境（类型 `Map`）。The environment.
runtimeConfigMap<String, Object>运行时配置（类型 `Map`）。The runtime config.
返回Returns ContainerCreateResult
返回ContainerCreateResult。Returns container create result.
源码Source io/agentscope/runtime/sandbox/manager/client/container/docker/DockerClient.java:86–128

startContainer

public void startContainer(String containerId)

启动容器。

Starts the container.

参数Parameters
名称Name类型Type说明Description
containerIdString容器标识（类型 `String`）。The container id.
源码Source io/agentscope/runtime/sandbox/manager/client/container/docker/DockerClient.java:154–160

stopContainer

public void stopContainer(String containerId)

停止容器。

Stops the container.

参数Parameters
名称Name类型Type说明Description
containerIdString容器标识（类型 `String`）。The container id.
源码Source io/agentscope/runtime/sandbox/manager/client/container/docker/DockerClient.java:162–168

removeContainer

public void removeContainer(String containerId)

移除容器。

Removes the container.

参数Parameters
名称Name类型Type说明Description
containerIdString容器标识（类型 `String`）。The container id.
源码Source io/agentscope/runtime/sandbox/manager/client/container/docker/DockerClient.java:170–186

getContainerStatus

public String getContainerStatus(String containerId)

获取容器状态。

Returns the container status.

参数Parameters
名称Name类型Type说明Description
containerIdString容器标识（类型 `String`）。The container id.
返回Returns String
返回字符串结果。Returns a string.
源码Source io/agentscope/runtime/sandbox/manager/client/container/docker/DockerClient.java:188–194

createContainers

public CreateContainerResponse createContainers(com.github.dockerjava.api.DockerClient client, String containerName, String imageName, List<String> ports, Map<String, Integer> portMapping, List<VolumeBinding> volumeBindings, Map<String, String> environment, Map<String, Object> runtimeConfig)

创建 createContainers。

Create container (supports port mapping)

参数Parameters
名称Name类型Type说明Description
clientcom.github.dockerjava.api.DockerClient客户端（类型 `com.github.dockerjava.api.DockerClient`）。Docker client
containerNameString容器名称（类型 `String`）。container name
imageNameString图像名称（类型 `String`）。image name
portsList<String>ports（类型 `List`）。port mapping list, format like ["80/tcp", "443/tcp"]
portMappingMap<String, Integer>port Mapping（类型 `Map`）。port mapping Map, key is container port, value is host port
volumeBindingsList<VolumeBinding>volume Bindings（类型 `List`）。volume mount mapping, using VolumeBinding object
environmentMap<String, String>环境（类型 `Map`）。environment variables
runtimeConfigMap<String, Object>运行时配置（类型 `Map`）。runtime configuration
返回Returns CreateContainerResponse
返回CreateContainerResponse。Returns create container response.
源码Source io/agentscope/runtime/sandbox/manager/client/container/docker/DockerClient.java:251–321

startContainer

public void startContainer(com.github.dockerjava.api.DockerClient client, String containerId)

启动容器。

Start container

参数Parameters
名称Name类型Type说明Description
clientcom.github.dockerjava.api.DockerClient客户端（类型 `com.github.dockerjava.api.DockerClient`）。Docker client
containerIdString容器标识（类型 `String`）。container ID
源码Source io/agentscope/runtime/sandbox/manager/client/container/docker/DockerClient.java:506–513

stopContainer

public void stopContainer(com.github.dockerjava.api.DockerClient client, String containerId)

停止容器。

Stop container

参数Parameters
名称Name类型Type说明Description
clientcom.github.dockerjava.api.DockerClient客户端（类型 `com.github.dockerjava.api.DockerClient`）。Docker client
containerIdString容器标识（类型 `String`）。container ID
源码Source io/agentscope/runtime/sandbox/manager/client/container/docker/DockerClient.java:521–533

removeContainer

public void removeContainer(com.github.dockerjava.api.DockerClient client, String containerId)

移除容器。

Delete container

参数Parameters
名称Name类型Type说明Description
clientcom.github.dockerjava.api.DockerClient客户端（类型 `com.github.dockerjava.api.DockerClient`）。Docker client
containerIdString容器标识（类型 `String`）。container ID
源码Source io/agentscope/runtime/sandbox/manager/client/container/docker/DockerClient.java:541–551

getContainerStatus

public String getContainerStatus(com.github.dockerjava.api.DockerClient client, String containerId)

获取容器状态。

Get container status

参数Parameters
名称Name类型Type说明Description
clientcom.github.dockerjava.api.DockerClient客户端（类型 `com.github.dockerjava.api.DockerClient`）。Docker client
containerIdString容器标识（类型 `String`）。container ID
返回Returns String
返回字符串结果。container status
源码Source io/agentscope/runtime/sandbox/manager/client/container/docker/DockerClient.java:560–568

stopAndRemoveContainer

public void stopAndRemoveContainer(com.github.dockerjava.api.DockerClient client, String containerId)

停止和移除容器。

Stop and delete container

参数Parameters
名称Name类型Type说明Description
clientcom.github.dockerjava.api.DockerClient客户端（类型 `com.github.dockerjava.api.DockerClient`）。Docker client
containerIdString容器标识（类型 `String`）。container ID
源码Source io/agentscope/runtime/sandbox/manager/client/container/docker/DockerClient.java:576–579

imageExists

public boolean imageExists(String imageName)

设置该参数。

Performs the image exists operation.

参数Parameters
名称Name类型Type说明Description
imageNameString图像名称（类型 `String`）。The image name.
返回Returns boolean
返回布尔值，表示判断结果。Returns a boolean result.
源码Source io/agentscope/runtime/sandbox/manager/client/container/docker/DockerClient.java:581–587

pullImage

public boolean pullImage(String imageName)

设置该参数。

Performs the pull image operation.

参数Parameters
名称Name类型Type说明Description
imageNameString图像名称（类型 `String`）。The image name.
返回Returns boolean
返回布尔值，表示判断结果。Returns a boolean result.
源码Source io/agentscope/runtime/sandbox/manager/client/container/docker/DockerClient.java:589–595

inspectContainer

public boolean inspectContainer(String containerIdOrName)

设置该参数。

Performs the inspect container operation.

参数Parameters
名称Name类型Type说明Description
containerIdOrNameString容器标识或名称（类型 `String`）。The container id or name.
返回Returns boolean
返回布尔值，表示判断结果。Returns a boolean result.
源码Source io/agentscope/runtime/sandbox/manager/client/container/docker/DockerClient.java:597–608

imageExists

public boolean imageExists(com.github.dockerjava.api.DockerClient client, String imageName)

执行 imageExists 方法。

Check if image exists locally

参数Parameters
名称Name类型Type说明Description
clientcom.github.dockerjava.api.DockerClient客户端（类型 `com.github.dockerjava.api.DockerClient`）。Docker client
imageNameString图像名称（类型 `String`）。image name
返回Returns boolean
返回布尔值，表示判断结果。whether image exists locally
源码Source io/agentscope/runtime/sandbox/manager/client/container/docker/DockerClient.java:617–637

pullImage

public boolean pullImage(com.github.dockerjava.api.DockerClient client, String imageName)

执行 pullImage 方法。

Pull image from registry

参数Parameters
名称Name类型Type说明Description
clientcom.github.dockerjava.api.DockerClient客户端（类型 `com.github.dockerjava.api.DockerClient`）。Docker client
imageNameString图像名称（类型 `String`）。image name
返回Returns boolean
返回布尔值，表示判断结果。whether pull was successful
源码Source io/agentscope/runtime/sandbox/manager/client/container/docker/DockerClient.java:646–670

containerNameExists

public boolean containerNameExists(String containerName)

设置该参数。

Performs the container name exists operation.

参数Parameters
名称Name类型Type说明Description
containerNameString容器名称（类型 `String`）。The container name.
返回Returns boolean
返回布尔值，表示判断结果。Returns a boolean result.
源码Source io/agentscope/runtime/sandbox/manager/client/container/docker/DockerClient.java:672–684

继承成员Inherited Members

继承自Methods inherited from BaseClient
stopAndRemoveContainer, ensureImageAvailable
基于官方固定版本源码静态生成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.