Docker Engine API

Docker 提供了一个用于与 Docker 守护进程交互的 API（称为 Docker Engine API），以及适用于 Go 和 Python 的 SDK。SDK 使您能够高效地构建和扩展 Docker 应用程序和解决方案。如果 Go 或 Python 不适合您，您可以直接使用 Docker Engine API。

有关 Docker Engine SDK 的信息，请参阅 使用 Docker Engine SDK 进行开发。

Docker Engine API 是一个 RESTful API，可以通过 HTTP 客户端（例如 wget 或 curl）或大多数现代编程语言内置的 HTTP 库访问。

查看 API 参考

您可以 查看最新版本的 API 参考 或 选择特定版本。

版本化 API 和 SDK

您应使用的 Docker Engine API 版本取决于您的 Docker 守护进程和 Docker 客户端的版本。

给定的 Docker Engine SDK 版本支持特定版本的 Docker Engine API 以及所有早期版本。如果发生破坏性更改，都会显著地记录下来。

注意

Docker 守护进程和客户端的版本不必始终相同。但请记住以下几点。

• 如果守护进程比客户端新，客户端将不知道守护进程中的新功能或已弃用的 API 端点。

• 如果客户端比守护进程新，客户端可能会请求守护进程不知道的 API 端点。

添加新功能时会发布新版本的 API。Docker API 是向后兼容的，因此您无需更新使用 API 的代码，除非您需要利用新功能。

要查看您的 Docker 守护进程和客户端支持的最高 API 版本，请使用 docker version 命令。

$ docker version
Client: Docker Engine - Community
 Version:           28.0.0
 API version:       1.48
 Go version:        go1.23.6
 Git commit:        f9ced58
 Built:             Wed Feb 19 22:11:04 2025
 OS/Arch:           linux/amd64
 Context:           default

Server: Docker Engine - Community
 Engine:
  Version:          28.0.0
  API version:      1.48 (minimum version 1.24)
  Go version:       go1.23.6
  Git commit:       af898ab
  Built:            Wed Feb 19 22:11:04 2025
  OS/Arch:          linux/amd64
  ...

您可以通过以下任何方式指定要使用的 API 版本

• 使用 SDK 时，请使用最新版本。至少应使用包含您所需功能 API 版本的 SDK 版本。

• 直接使用 curl 时，将版本指定为 URL 的第一部分。例如，如果端点是 /containers/，您可以使用 /v1.49/containers/。

• 要强制 Docker CLI 或 Docker Engine SDK 使用比 docker version 命令报告的版本更旧的 API 版本，请将环境变量 DOCKER_API_VERSION 设置为正确的版本。这适用于 Linux、Windows 或 macOS 客户端。

  $ DOCKER_API_VERSION=1.48
  

  设置此环境变量后，将使用该版本的 API，即使 Docker 守护进程支持更新的版本也是如此。此环境变量会禁用 API 版本协商，因此仅当您必须使用特定版本的 API 或出于调试目的时才应使用它。

• Docker Go SDK 允许您启用 API 版本协商，自动选择客户端和正在使用的 Docker Engine 都支持的 API 版本。

• 对于 SDK，您还可以通过编程方式将 API 版本指定为 client 对象的参数。请参阅 Go 构造函数 或 Python SDK 中关于 client 的文档。

API 版本矩阵

已弃用的 API 版本

v1.24 之前的 API 版本 已弃用。您可以在 GitHub 上的代码仓库中找到已弃用 API 版本的存档文档

• v1.23 及更早版本的 API 文档.
• v1.17 及更早版本的 API 文档.