切换语言

接口：Docker

目录

Since

0.2.0

性能

命令行界面

•Readonly CLI 中：DockerCommand

您也可以直接执行 Docker Binaries。

const output = await ddClient.docker.cli.exec("volume", [
  "ls",
  "--filter",
  "dangling=true"
]);

输出：

{
  "stderr": "...",
  "stdout": "..."
}

为方便起见，命令 result 对象还具有根据输出格式轻松解析它的方法。请参阅 ExecResult 。

流式传输作为执行 Docker 命令的结果的输出。 当命令的输出太长，或者您需要将输出作为流获取时，它非常有用。

await ddClient.docker.cli.exec("logs", ["-f", "..."], {
  stream: {
    onOutput(data): void {
        // As we can receive both `stdout` and `stderr`, we wrap them in a JSON object
        JSON.stringify(
          {
            stdout: data.stdout,
            stderr: data.stderr,
          },
          null,
          "  "
        );
    },
    onError(error: any): void {
      console.error(error);
    },
    onClose(exitCode: number): void {
      console.log("onClose with exit code " + exitCode);
    },
  },
});

方法

列表容器

▸ 列表容器(options?):Promise<unknown>

获取正在运行的容器列表（与docker ps).

默认情况下，这不会列出已停止的容器。 您可以使用选项{"all": true}列出所有正在运行和已停止的容器。

const containers = await ddClient.docker.listContainers();

参数

名字类型描述
options?any（可选）。JSON 格式为{ "all": true, "limit": 10, "size": true, "filters": JSON.stringify({ status: ["exited"] }), }有关不同属性的更多信息，请参阅 Docker API 端点文档。

返回

Promise<unknown>

列表图片

▸ 列表图片(options?):Promise<unknown>

获取本地容器镜像列表

const images = await ddClient.docker.listImages();

参数

名字类型描述
options?any（可选）。JSON 格式为{ "all": true, "filters": JSON.stringify({ dangling: ["true"] }), "digests": true * }有关不同属性的更多信息，请参阅 Docker API 端点文档。

返回

Promise<unknown>