接口：DockerDesktopClient

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

性能

后端

• 后端： |后端 V0Readonlyundefined

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

警告

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

继承自

DockerDesktopClientV0.backend

外延

• extension：扩展Readonly

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

继承自

DockerDesktopClientV1.扩展

桌面用户界面

• desktopUI：DesktopUIReadonly

继承自

DockerDesktopClientV1.desktopUI

主机

• host：主机Readonly

继承自

DockerDesktopClientV1.主机

Docker

• docker：DockerReadonly

继承自

DockerDesktopClientV1.docker

容器方法

列表容器

▸ listContainers（）的容器：optionsPromise<unknown>

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

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

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

警告

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

参数

返回

Promise<unknown>

继承自

DockerDesktopClientV0.listContainers

镜像方法

列表图片

▸ listImages（）：optionsPromise<unknown>

获取镜像列表

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

警告

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

参数

返回

Promise<unknown>

继承自

DockerDesktopClientV0.listImages

导航方法

导航到容器

▸ navigateToContainers（）：void

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

window.ddClient.navigateToContainers();

警告

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

返回

void

继承自

DockerDesktopClientV0.navigateToContainers

navigateToContainer

▸ navigateToContainer（） 的idPromise<any>

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

await window.ddClient.navigateToContainer(id);

警告

它将在未来版本中删除。

参数

返回

Promise<any>

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

继承自

DockerDesktopClientV0.navigateToContainer

navigateToContainerLogs

▸ navigateToContainerLogs（） 中：idPromise<any>

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

await window.ddClient.navigateToContainerLogs(id);

警告

它将在未来版本中删除。

参数

返回

Promise<any>

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

继承自

DockerDesktopClientV0.navigateToContainerLogs

导航到容器检查

▸ navigateToContainerInspect（） 中：idPromise<any>

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

await window.ddClient.navigateToContainerInspect(id);

警告

它将在未来版本中删除。

参数

返回

Promise<any>

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

继承自

DockerDesktopClientV0.navigateToContainerInspect

navigateToContainerStats

▸ navigateToContainerStats（） 中：idPromise<any>

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

await window.ddClient.navigateToContainerStats(id);

警告

它将在未来版本中删除。

参数

返回

Promise<any>

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

继承自

DockerDesktopClientV0.navigateToContainerStats

导航至镜像

▸ navigateToImages（） 的 URL：void

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

await window.ddClient.navigateToImages(id);

警告

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

返回

void

继承自

DockerDesktopClientV0.navigateToImages

导航至镜像

▸ navigateToImage（， ）：idtagPromise<any>

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

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

警告

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

参数

返回

Promise<any>

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

继承自

DockerDesktopClientV0.navigateToImage

navigateToVolumes

▸ navigateToVolumes（）：void

导航到 Docker Desktop 中的卷窗口。

await window.ddClient.navigateToVolumes();

警告

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

返回

void

继承自

DockerDesktopClientV0.navigateToVolumes

navigateToVolume

▸ navigateToVolume（） 的别名：volumevoid

导航到 Docker Desktop 中的特定卷。

window.ddClient.navigateToVolume(volume);

警告

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

参数

返回

void

继承自

DockerDesktopClientV0.navigateToVolume

导航到DevEnvironments

▸ navigateToDevEnvironments（）：void

导航到 Docker Desktop 中的 Dev Environments 窗口。

window.ddClient.navigateToDevEnvironments();

警告

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

返回

void

继承自

DockerDesktopClientV0.navigateToDevEnvironments

其他方法

execHostCmd 的

▸ execHostCmd（）：< ExecResultV0cmdPromise>

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

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

警告

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

参数

返回

Promise< ExecResultV0>

继承自

DockerDesktopClientV0.execHostCmd

spawnHostCmd 的

▸ spawnHostCmd（， ， ）：cmdargscallbackvoid

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

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

execDockerCmd

▸ execDockerCmd（， ）： < ExecResultV0cmd...argsPromise>

您也可以直接执行 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

spawnDockerCmd 的

▸ spawnDockerCmd（， ， ）：cmdargscallbackvoid

警告

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

参数

返回

void

继承自

DockerDesktopClientV0.spawnDockerCmd

open外部

▸ openExternal（）：urlvoid

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

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

警告

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

参数

返回

void

继承自

DockerDesktopClientV0.openExternal

Toast 方法

toastSuccess

▸ toastSuccess（）：msgvoid

显示 success 类型的 toast 消息。

window.ddClient.toastSuccess("message");

警告

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

参数

返回

void

继承自

DockerDesktopClientV0.toast成功

吐司警告

▸ toastWarning（）：msgvoid

显示 warning 类型的 toast 消息。

window.ddClient.toastWarning("message");

警告

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

参数

返回

void

继承自

DockerDesktopClientV0.toast 警告

toastError 错误

▸ toastError（） 的调用：msgvoid

显示 error 类型的 toast 消息。

window.ddClient.toastError("message");

警告

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

参数

返回

void

继承自

DockerDesktopClientV0.toast错误