介面：Docker

目錄

自

0.2.0

屬性

命令列

• 只讀 cli: DockerCommand

您也可以直接執行 Docker 二進位制檔案。

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

輸出

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

為方便起見，命令結果物件還具有根據輸出格式輕鬆解析它的方法。請參閱 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);
    },
  },
});

方法

listContainers

▸ listContainers(options?): Promise<unknown>

獲取正在執行的容器列表（與 docker ps 相同）。

預設情況下，這不會列出已停止的容器。您可以使用選項 {"all": true} 來列出所有正在執行和已停止的容器。

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

引數

名稱型別描述
選項？任意(可選)。一個 JSON 物件，如 { "all": true, "limit": 10, "size": true, "filters": JSON.stringify({ status: ["exited"] }), } 有關不同屬性的更多資訊，請參閱 Docker API 端點文件。

返回

Promise<未知>

listImages

▸ listImages(options?): Promise<unknown>

獲取本地容器映象列表

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

引數

名稱型別描述
選項？任意(可選)。一個 JSON 物件，如 { "all": true, "filters": JSON.stringify({ dangling: ["true"] }), "digests": true * } 有關不同屬性的更多資訊，請參閱 Docker API 端點文件。

返回

Promise<未知>