接口：DockerDesktopClient

Docker Desktop API 客户端的 v0 和 v1 接口的混合体，出于向后兼容性原因而提供。除非您使用旧版扩展，否则请使用 v1 类型。

特性

后端

•Readonly 后端：undefined| BackendV0

该window.ddClient.backend对象可用于与扩展元数据的 vm 部分中定义的后端进行通信。客户端已经连接到后端。

警告

它将在未来版本中删除。请改用 扩展名。

继承自

DockerDesktopClientV0.backend

扩大

•Readonly 扩大： Extension

该ddClient.extension对象可用于与扩展元数据的 vm 部分中定义的后端进行通信。客户端已经连接到后端。

继承自

DockerDesktopClientV1.扩展

桌面用户界面

•Readonly 桌面用户界面： DesktopUI

继承自

DockerDesktopClientV1.desktopUI

主持人

•Readonly 主持人： Host

继承自

DockerDesktopClientV1.host

泊坞窗

•Readonly Docker： Docker

继承自

DockerDesktopClientV1.docker

容器方法

列表容器

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

获取正在运行的容器列表（同docker ps）。

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

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

警告

它将在未来版本中删除。请改用 listContainers。

参数

退货

Promise< unknown>

继承自

DockerDesktopClientV0.listContainers

图像法

列表图片

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

获取图像列表

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

警告

它将在未来版本中删除。请改用 listImages。

参数

退货

Promise< unknown>

继承自

DockerDesktopClientV0.listImages

导航方法

导航至容器

▸导航到容器（）：void

导航到 Docker Desktop 中容器的窗口。

window.ddClient.navigateToContainers();

警告

它将在未来版本中删除。请改用 viewContainers。

退货

void

继承自

DockerDesktopClientV0.navigateToContainers

导航至容器

▸导航到容器( id): Promise< any>

导航到 Docker Desktop 中的容器窗口。

await window.ddClient.navigateToContainer(id);

警告

它将在未来版本中删除。

参数

退货

Promise< any>

如果容器不存在，则承诺将失败。

继承自

DockerDesktopClientV0.navigateToContainer

导航至容器日志

▸导航到容器日志( id): Promise< any>

导航到 Docker Desktop 中的容器日志窗口。

await window.ddClient.navigateToContainerLogs(id);

警告

它将在未来版本中删除。

参数

退货

Promise< any>

如果容器不存在，则承诺将失败。

继承自

DockerDesktopClientV0.navigateToContainerLogs

导航至容器检查

▸导航到容器检查( id): Promise< any>

导航到 Docker Desktop 中的容器检查窗口。

await window.ddClient.navigateToContainerInspect(id);

警告

它将在未来版本中删除。

参数

退货

Promise< any>

如果容器不存在，则承诺将失败。

继承自

DockerDesktopClientV0.navigateToContainerInspect

导航至容器统计

▸ navigatorToContainerStats ( id): Promise< any>

导航到容器统计信息以查看 CPU、内存、磁盘读/写和网络 I/O 使用情况。

await window.ddClient.navigateToContainerStats(id);

警告

它将在未来版本中删除。

参数

退货

Promise< any>

如果容器不存在，则承诺将失败。

继承自

DockerDesktopClientV0.navigateToContainerStats

导航到图像

▸导航到图像（）：void

导航到 Docker Desktop 中的图像窗口。

await window.ddClient.navigateToImages(id);

警告

它将在未来版本中删除。请改用 viewImages。

退货

void

继承自

DockerDesktopClientV0.navigateToImages

导航到图像

▸导航到图像( id, tag): Promise< any>

id导航到tagDocker Desktop引用的特定映像。在此导航路线中，您可以找到图像图层、命令、创建时间和大小。

await window.ddClient.navigateToImage(id, tag);

警告

它将在未来版本中删除。使用 viewImage代替。

参数

退货

Promise< any>

如果容器不存在，则承诺将失败。

继承自

DockerDesktopClientV0.navigateToImage

导航到卷

▸导航到卷（）：void

导航到 Docker Desktop 中的卷窗口。

await window.ddClient.navigateToVolumes();

警告

它将在未来版本中删除。请改用 viewVolumes。

退货

void

继承自

DockerDesktopClientV0.navigateToVolumes

导航到卷

▸导航到体积( volume):void

导航到 Docker Desktop 中的特定卷。

window.ddClient.navigateToVolume(volume);

警告

它将在未来版本中删除。请改用 viewVolume。

参数

退货

void

继承自

DockerDesktopClientV0.navigateToVolume

导航至开发环境

▸导航到开发环境（）：void

导航到 Docker Desktop 中的“开发环境”窗口。

window.ddClient.navigateToDevEnvironments();

警告

它将在未来版本中删除。请改用 viewDevEnvironments。

退货

void

继承自

DockerDesktopClientV0.navigateToDevEnvironments

其他方法

执行主机命令

▸ execHostCmd ( cmd): Promise< ExecResultV0>

您可以运行扩展元数据的主机部分中定义的二进制文件。

window.ddClient.execHostCmd(`cliShippedOnHost xxx`).then((cmdResult: any) => {
 console.log(cmdResult);
});

警告

它将在未来版本中删除。请改用 exec。

参数

退货

Promise< ExecResultV0>

继承自

DockerDesktopClientV0.execHostCmd

生成主机命令

▸spawnHostCmd ( ,cmd , args) callback:void

在主机上调用扩展二进制文件并获取输出流。

window.ddClient.spawnHostCmd(
  `cliShippedOnHost`,
  [`arg1`, `arg2`],
  (data: any, err: any) => {
    console.log(data.stdout, data.stderr);
    // Once the command exits we get the status code
    if (data.code) {
      console.log(data.code);
    }
  }
);

警告

它将在未来版本中删除。请改用 exec。

参数

退货

void

继承自

DockerDesktopClientV0.spawnHostCmd

执行DockerCmd

▸ execDockerCmd ( cmd, ...args): Promise< ExecResultV0>

您还可以直接执行 Docker 二进制文件。

const output = await window.ddClient.execDockerCmd("info");

警告

它将在未来版本中删除。请改用 exec。

参数

退货

Promise< ExecResultV0>

结果将包含执行命令的标准输出和标准错误：

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

为了方便起见，命令结果对象还具有根据输出格式轻松解析它的方法：

• output.lines(): string[]分割输出线。
• output.parseJsonObject(): any解析格式良好的 JSON 输出。
• output.parseJsonLines(): any[]将每个输出行解析为 JSON 对象。

如果命令的输出太长，或者您需要以流的形式获取输出，您可以使用

• spawnDockerCmd 函数：

window.ddClient.spawnDockerCmd("logs", ["-f", "..."], (data, error) => {
  console.log(data.stdout);
});

继承自

DockerDesktopClientV0.execDockerCmd

生成DockerCmd

▸spawnDockerCmd ( ,cmd , args) callback:void

警告

它将在未来版本中删除。请改用 exec。

参数

退货

void

继承自

DockerDesktopClientV0.spawnDockerCmd

开放外部

▸打开外部( url):void

使用系统默认浏览器打开外部 URL。

window.ddClient.openExternal("https://docker.com");

警告

它将在未来版本中删除。请改用 openExternal。

参数

退货

void

继承自

DockerDesktopClientV0.openExternal

吐司方法

祝酒成功

▸吐司成功( msg):void

显示类型为 success 的 toast 消息。

window.ddClient.toastSuccess("message");

警告`

它将在未来版本中删除。使用 成功来代替。

参数

退货

void

继承自

DockerDesktopClientV0.toastSuccess

吐司警告

▸ toast 警告( msg):void

显示警告类型的 Toast 消息。

window.ddClient.toastWarning("message");

警告

它将在未来版本中删除。请改用 警告。

参数

退货

void

继承自

DockerDesktopClientV0.toastWarning

吐司错误

▸吐司错误( msg):void

显示错误类型的 toast 消息。

window.ddClient.toastError("message");

警告

它将在未来版本中删除。使用 错误代替。

参数

退货

void

继承自

DockerDesktopClientV0.toastError