directory search
Compose About versions and upgrading (Compose) ASP.NET Core + SQL Server on Linux (Compose) CLI environment variables (Compose) Command-line completion (Compose) Compose(组成) Compose command-line reference(组合命令行参考) Control startup order (Compose) Django and PostgreSQL (Compose) Docker stacks and distributed application bundles (Compose) docker-compose build(docker-compose构建) docker-compose bundle docker-compose config docker-compose create docker-compose down docker-compose events docker-compose exec docker-compose help docker-compose images docker-compose kill docker-compose logs docker-compose pause docker-compose port docker-compose ps docker-compose pull docker-compose push docker-compose restart docker-compose rm docker-compose run docker-compose scale docker-compose start docker-compose stop docker-compose top docker-compose unpause docker-compose up Environment file (Compose) Environment variables in Compose Extend services in Compose Frequently asked questions (Compose) Getting started (Compose) Install Compose Link environment variables (deprecated) (Compose) Networking in Compose Overview of Docker Compose Overview of docker-compose CLI Quickstart: Compose and WordPress Rails and PostgreSQL (Compose) Sample apps with Compose Using Compose in production Using Compose with Swarm Engine .NET Core application (Engine) About images, containers, and storage drivers (Engine) Add nodes to the swarm (Engine) Apply custom metadata (Engine) Apply rolling updates (Engine) apt-cacher-ng Best practices for writing Dockerfiles (Engine) Binaries (Engine) Bind container ports to the host (Engine) Breaking changes (Engine) Build your own bridge (Engine) Configure container DNS (Engine) Configure container DNS in user-defined networks (Engine) CouchDB (Engine) Create a base image (Engine) Create a swarm (Engine) Customize the docker0 bridge (Engine) Debian (Engine) Default bridge network Delete the service (Engine) Deploy a service (Engine) Deploy services to a swarm (Engine) Deprecated Engine features Docker container networking (Engine) Docker overview (Engine) Docker run reference (Engine) Dockerfile reference (Engine) Dockerize an application Drain a node (Engine) Engine FAQ (Engine) Fedora (Engine) Get started (Engine) Get started with macvlan network driver (Engine) Get started with multi-host networking (Engine) How nodes work (Engine) How services work (Engine) Image management (Engine) Inspect the service (Engine) Install Docker (Engine) IPv6 with Docker (Engine) Join nodes to a swarm (Engine) Legacy container links (Engine) Lock your swarm (Engine) Manage nodes in a swarm (Engine) Manage sensitive data with Docker secrets (Engine) Manage swarm security with PKI (Engine) Manage swarm service networks (Engine) Migrate to Engine 1.10 Optional Linux post-installation steps (Engine) Overview (Engine) PostgreSQL (Engine) Raft consensus in swarm mode (Engine) Riak (Engine) Run Docker Engine in swarm mode Scale the service (Engine) SDKs (Engine) Select a storage driver (Engine) Set up for the tutorial (Engine) SSHd (Engine) Storage driver overview (Engine) Store service configuration data (Engine) Swarm administration guide (Engine) Swarm mode key concepts (Engine) Swarm mode overlay network security model (Engine) Swarm mode overview (Engine) Understand container communication (Engine) Use multi-stage builds (Engine) Use swarm mode routing mesh (Engine) Use the AUFS storage driver (Engine) Use the Btrfs storage driver (Engine) Use the Device mapper storage driver (Engine) Use the OverlayFS storage driver (Engine) Use the VFS storage driver (Engine) Use the ZFS storage driver (Engine) Engine: Admin Guide Amazon CloudWatch logs logging driver (Engine) Bind mounts (Engine) Collect Docker metrics with Prometheus (Engine) Configuring and running Docker (Engine) Configuring logging drivers (Engine) Control and configure Docker with systemd (Engine) ETW logging driver (Engine) Fluentd logging driver (Engine) Format command and log output (Engine) Google Cloud logging driver (Engine) Graylog Extended Format (GELF) logging driver (Engine) Journald logging driver (Engine) JSON File logging driver (Engine) Keep containers alive during daemon downtime (Engine) Limit a container's resources (Engine) Link via an ambassador container (Engine) Log tags for logging driver (Engine) Logentries logging driver (Engine) PowerShell DSC usage (Engine) Prune unused Docker objects (Engine) Run multiple services in a container (Engine) Runtime metrics (Engine) Splunk logging driver (Engine) Start containers automatically (Engine) Storage overview (Engine) Syslog logging driver (Engine) tmpfs mounts Troubleshoot volume problems (Engine) Use a logging driver plugin (Engine) Using Ansible (Engine) Using Chef (Engine) Using Puppet (Engine) View a container's logs (Engine) Volumes (Engine) Engine: CLI Daemon CLI reference (dockerd) (Engine) docker docker attach docker build docker checkpoint docker checkpoint create docker checkpoint ls docker checkpoint rm docker commit docker config docker config create docker config inspect docker config ls docker config rm docker container docker container attach docker container commit docker container cp docker container create docker container diff docker container exec docker container export docker container inspect docker container kill docker container logs docker container ls docker container pause docker container port docker container prune docker container rename docker container restart docker container rm docker container run docker container start docker container stats docker container stop docker container top docker container unpause docker container update docker container wait docker cp docker create docker deploy docker diff docker events docker exec docker export docker history docker image docker image build docker image history docker image import docker image inspect docker image load docker image ls docker image prune docker image pull docker image push docker image rm docker image save docker image tag docker images docker import docker info docker inspect docker kill docker load docker login docker logout docker logs docker network docker network connect docker network create docker network disconnect docker network inspect docker network ls docker network prune docker network rm docker node docker node demote docker node inspect docker node ls docker node promote docker node ps docker node rm docker node update docker pause docker plugin docker plugin create docker plugin disable docker plugin enable docker plugin inspect docker plugin install docker plugin ls docker plugin push docker plugin rm docker plugin set docker plugin upgrade docker port docker ps docker pull docker push docker rename docker restart docker rm docker rmi docker run docker save docker search docker secret docker secret create docker secret inspect docker secret ls docker secret rm docker service docker service create docker service inspect docker service logs docker service ls docker service ps docker service rm docker service scale docker service update docker stack docker stack deploy docker stack ls docker stack ps docker stack rm docker stack services docker start docker stats docker stop docker swarm docker swarm ca docker swarm init docker swarm join docker swarm join-token docker swarm leave docker swarm unlock docker swarm unlock-key docker swarm update docker system docker system df docker system events docker system info docker system prune docker tag docker top docker unpause docker update docker version docker volume docker volume create docker volume inspect docker volume ls docker volume prune docker volume rm docker wait Use the Docker command line (Engine) Engine: Extend Access authorization plugin (Engine) Docker log driver plugins Docker network driver plugins (Engine) Extending Engine with plugins Managed plugin system (Engine) Plugin configuration (Engine) Plugins API (Engine) Volume plugins (Engine) Engine: Security AppArmor security profiles for Docker (Engine) Automation with content trust (Engine) Content trust in Docker (Engine) Delegations for content trust (Engine) Deploying Notary (Engine) Docker security (Engine) Docker security non-events (Engine) Isolate containers with a user namespace (Engine) Manage keys for content trust (Engine) Play in a content trust sandbox (Engine) Protect the Docker daemon socket (Engine) Seccomp security profiles for Docker (Engine) Secure Engine Use trusted images Using certificates for repository client verification (Engine) Engine: Tutorials Engine tutorials Network containers (Engine) Get Started Part 1: Orientation Part 2: Containers Part 3: Services Part 4: Swarms Part 5: Stacks Part 6: Deploy your app Machine Amazon Web Services (Machine) Digital Ocean (Machine) docker-machine active docker-machine config docker-machine create docker-machine env docker-machine help docker-machine inspect docker-machine ip docker-machine kill docker-machine ls docker-machine provision docker-machine regenerate-certs docker-machine restart docker-machine rm docker-machine scp docker-machine ssh docker-machine start docker-machine status docker-machine stop docker-machine upgrade docker-machine url Driver options and operating system defaults (Machine) Drivers overview (Machine) Exoscale (Machine) Generic (Machine) Get started with a local VM (Machine) Google Compute Engine (Machine) IBM Softlayer (Machine) Install Machine Machine Machine CLI overview Machine command-line completion Machine concepts and help Machine overview Microsoft Azure (Machine) Microsoft Hyper-V (Machine) Migrate from Boot2Docker to Machine OpenStack (Machine) Oracle VirtualBox (Machine) Provision AWS EC2 instances (Machine) Provision Digital Ocean Droplets (Machine) Provision hosts in the cloud (Machine) Rackspace (Machine) VMware Fusion (Machine) VMware vCloud Air (Machine) VMware vSphere (Machine) Notary Client configuration (Notary) Common Server and signer configurations (Notary) Getting started with Notary Notary changelog Notary configuration files Running a Notary service Server configuration (Notary) Signer configuration (Notary) Understand the service architecture (Notary) Use the Notary client
characters

在安装 Docker 之后,您可以尝试 Docker API。

或者,为您正在使用的语言安装 SDK。官方 SDK 可用于 Python 和 Go,以及一些社区维护的其他语言库。

了解有关安装和使用 Docker SDK的更多信息。

这些例子展示了如何使用 Python,Go或curl直接使用来执行相同的操作。

版本化的 API

这里使用的 Python 和 Go 示例没有指定要使用的 API 版本,因为它们使用长期以来一直是 Docker 一部分的功能。Docker API完全向后兼容。

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

$ docker version

Client:
 Version:      17.04.0-ce
 API version:  1.28
 Go version:   go1.7.5
 Git commit:   4845c56
 Built:        Wed Apr  5 06:06:36 2017
 OS/Arch:      darwin/amd64

Server:
 Version:      17.04.0-ce
 API version:  1.28 (minimum version 1.12)
 Go version:   go1.7.5
 Git commit:   4845c56
 Built:        Tue Apr  4 00:37:25 2017
 OS/Arch:      linux/amd64
 Experimental: true

您可以通过以下方式之一指定要使用的 API 版本:

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

  • 对于 SDK,或强制 Docker CLI 使用特定版本的 API,请将环境变量DOCKER_API_VERSION设置为正确的版本。这适用于 Linux,Windows 或 MacOS 客户端。

DOCKER_API_VERSION = '1.27'

虽然环境变量已设置,但即使 Docker 守护程序支持较新版本,也会使用该版本的API。

  • 对于 SDK,您还可以通过编程方式指定 API 版本作为client对象的参数。请参阅Go的构造函数或Python SDK文档client。API 示例运行容器第一个示例演示如何使用 Docker API 运行容器。在命令行上,您可以使用该docker run命令,但这同样适用于您自己的应用程序。这与docker run alpine echo hello world在命令提示符下键入相同:

  • Python

  • Go

  • Curl

import docker
client = docker.from_env()print client.containers.run("alpine", ["echo", "hello", "world"])
package mainimport (  "io"  "os"  "github.com/docker/docker/client"  "github.com/docker/docker/api/types"  "github.com/docker/docker/api/types/container"  "golang.org/x/net/context")func main() {
  ctx := context.Background()
  cli, err := client.NewEnvClient()  if err != nil {    panic(err)  }

  _, err = cli.ImagePull(ctx, "docker.io/library/alpine", types.ImagePullOptions{})  if err != nil {    panic(err)  }

  resp, err := cli.ContainerCreate(ctx, &container.Config{
    Image: "alpine",
    Cmd:   []string{"echo", "hello world"},  }, nil, nil, "")  if err != nil {    panic(err)  }  if err := cli.ContainerStart(ctx, resp.ID, types.ContainerStartOptions{}); err != nil {    panic(err)  }  if _, err = cli.ContainerWait(ctx, resp.ID); err != nil {    panic(err)  }

  out, err := cli.ContainerLogs(ctx, resp.ID, types.ContainerLogsOptions{ShowStdout: true})  if err != nil {    panic(err)  }

  io.Copy(os.Stdout, out)}
$ curl --unix-socket /var/run/docker.sock -H "Content-Type: application/json" \  -d '{"Image": "alpine", "Cmd": ["echo", "hello world"]}' \  -X POST http:/v1.24/containers/create{"Id":"1c6594faf5","Warnings":null}$ curl --unix-socket /var/run/docker.sock -X POST http:/v1.24/containers/1c6594faf5/start

$ curl --unix-socket /var/run/docker.sock -X POST http:/v1.24/containers/1c6594faf5/wait{"StatusCode":0}$ curl --unix-socket /var/run/docker.sock "http:/v1.24/containers/1c6594faf5/logs?stdout=1"hello world

在后台运行一个容器

你也可以在后台运行容器,相当于输入docker run -d bfirsh/reticulate-splines

  • Python

  • Go

  • Curl

import docker
client = docker.from_env()container = client.containers.run("bfirsh/reticulate-splines", detach=True)print container.id
package mainimport (  "fmt"  "io"  "os"  "github.com/docker/docker/api/types"  "github.com/docker/docker/api/types/container"  "github.com/docker/docker/client"  "golang.org/x/net/context")func main() {
  ctx := context.Background()
  cli, err := client.NewEnvClient()  if err != nil {    panic(err)  }

  imageName := "bfirsh/reticulate-splines"

  out, err := cli.ImagePull(ctx, imageName, types.ImagePullOptions{})  if err != nil {    panic(err)  }
  io.Copy(os.Stdout, out)

  resp, err := cli.ContainerCreate(ctx, &container.Config{
    Image: imageName,  }, nil, nil, "")  if err != nil {    panic(err)  }  if err := cli.ContainerStart(ctx, resp.ID, types.ContainerStartOptions{}); err != nil {    panic(err)  }

  fmt.Println(resp.ID)}
$ curl --unix-socket /var/run/docker.sock -H "Content-Type: application/json" \  -d '{"Image": "bfirsh/reticulate-splines"}' \  -X POST http:/v1.24/containers/create{"Id":"1c6594faf5","Warnings":null}$ curl --unix-socket /var/run/docker.sock -X POST http:/v1.24/containers/1c6594faf5/start

列出并管理容器

您可以使用 API 列出正在运行的容器,就像使用一样docker ps

  • Python

  • Go

  • Curl

import docker
client = docker.from_env()for container in client.containers.list():
  print container.id
package mainimport (  "context"  "fmt"  "github.com/docker/docker/api/types"  "github.com/docker/docker/client")func main() {
  cli, err := client.NewEnvClient()  if err != nil {    panic(err)  }

  containers, err := cli.ContainerList(context.Background(), types.ContainerListOptions{})  if err != nil {    panic(err)  }  for _, container := range containers {
    fmt.Println(container.ID)  }}
$ curl --unix-socket /var/run/docker.sock http:/v1.24/containers/json[{  "Id":"ae63e8b89a26f01f6b4b2c9a7817c31a1b6196acf560f66586fbc8809ffcd772",  "Names":["/tender_wing"],  "Image":"bfirsh/reticulate-splines",  ...}]

停止所有运行的容器

现在您知道存在哪些容器,您可以对它们执行操作。例如,要停止所有正在运行的容器:

  • Python

  • Go

  • Curl

import docker
client = docker.from_env()for container in client.containers.list():
  container.stop()
package mainimport (  "context"  "github.com/docker/docker/api/types"  "github.com/docker/docker/client")func main() {
  ctx := context.Background()
  cli, err := client.NewEnvClient()  if err != nil {    panic(err)  }

  containers, err := cli.ContainerList(ctx, types.ContainerListOptions{})  if err != nil {    panic(err)  }  for _, container := range containers {    if err := cli.ContainerStop(ctx, container.ID, nil); err != nil {      panic(err)    }  }}
$ curl --unix-socket /var/run/docker.sock http:/v1.24/containers/json[{  "Id":"ae63e8b89a26f01f6b4b2c9a7817c31a1b6196acf560f66586fbc8809ffcd772",  "Names":["/tender_wing"],  "Image":"bfirsh/reticulate-splines",  ...}]$ curl --unix-socket /var/run/docker.sock \  -X POST http:/v1.24/containers/ae63e8b89a26/stop

打印特定容器的日志

您也可以对单个容器执行操作。这个例子打印给定 ID 的容器的日志:

  • Python

  • Go

  • Curl

import docker
client = docker.from_env()container = client.containers.get('f1064a8a4c82')print container.logs()
package mainimport (  "context"  "io"  "os"  "github.com/docker/docker/api/types"  "github.com/docker/docker/client")func main() {
  ctx := context.Background()
  cli, err := client.NewEnvClient()  if err != nil {    panic(err)  }

  options := types.ContainerLogsOptions{ShowStdout: true}
  out, err := cli.ContainerLogs(ctx, "f1064a8a4c82", options)  if err != nil {    panic(err)  }

  io.Copy(os.Stdout, out)}
$ curl --unix-socket /var/run/docker.sock "http:/v1.24/containers/ca5f55cdb/logs?stdout=1"Reticulating spline 1...Reticulating spline 2...Reticulating spline 3...Reticulating spline 4...Reticulating spline 5...

列出所有图像

列出引擎上的图像,类似于docker images

  • Python

  • Go

  • Curl

import docker
client = docker.from_env()for image in client.images.list():
  print image.id
package mainimport (  "context"  "fmt"  "github.com/docker/docker/api/types"  "github.com/docker/docker/client")func main() {
  cli, err := client.NewEnvClient()  if err != nil {    panic(err)  }

  images, err := cli.ImageList(context.Background(), types.ImageListOptions{})  if err != nil {    panic(err)  }  for _, image := range images {
    fmt.Println(image.ID)  }}
$ curl --unix-socket /var/run/docker.sock http:/v1.24/images/json[{  "Id":"sha256:31d9a31e1dd803470c5a151b8919ef1988ac3efd44281ac59d43ad623f275dcd",  "ParentId":"sha256:ee4603260daafe1a8c2f3b78fd760922918ab2441cbb2853ed5c439e59c52f96",  ...}]

Pull image

Pull images,像docker pull

  • Python

  • Go

  • Curl

import docker
client = docker.from_env()image = client.images.pull("alpine")print image.id
package mainimport (  "io"  "os"  "github.com/docker/docker/api/types"  "github.com/docker/docker/client"  "golang.org/x/net/context")func main() {
  ctx := context.Background()
  cli, err := client.NewEnvClient()  if err != nil {    panic(err)  }

  out, err := cli.ImagePull(ctx, "alpine", types.ImagePullOptions{})  if err != nil {    panic(err)  }

  defer out.Close()

  io.Copy(os.Stdout, out)}
$ curl --unix-socket /var/run/docker.sock \  -X POST "http:/v1.24/images/create?fromImage=alpine"{"status":"Pulling from library/alpine","id":"3.1"}{"status":"Pulling fs layer","progressDetail":{},"id":"8f13703509f7"}{"status":"Downloading","progressDetail":{"current":32768,"total":2244027},"progress":"[\u003e                                                  ] 32.77 kB/2.244 MB","id":"8f13703509f7"}...

Pull images with authentication

docker pull通过身份验证提取图片,例如:

注意:凭证以明文形式发送。Docker 官方注册管理机构使用 HTTPS。私人注册管理机构也应配置为使用 HTTPS。

  • Python

  • Go

  • Curl

Python SDK 从凭证存储文件中检索认证信息并与凭证助手集成。可以覆盖这些凭据,但这不在本入门指南的范围之内。使用后docker login,Python SDK会自动使用这些凭据。

import docker
client = docker.from_env()image = client.images.pull("alpine")print image.id
package mainimport (  "io"  "os"  "encoding/json"  "encoding/base64"  "github.com/docker/docker/api/types"  "github.com/docker/docker/client"  "golang.org/x/net/context")func main() {
  ctx := context.Background()
  cli, err := client.NewEnvClient()  if err != nil {    panic(err)  }

  authConfig := types.AuthConfig{
      Username: "username",
      Password: "password",  }
  encodedJSON, err := json.Marshal(authConfig)  if err != nil {      panic(err)  }
  authStr := base64.URLEncoding.EncodeToString(encodedJSON)

  out, err := cli.ImagePull(ctx, "alpine", types.ImagePullOptions{RegistryAuth:
  authStr})  if err != nil {    panic(err)  }

  defer out.Close()
  io.Copy(os.Stdout, out)}

这个例子会将证书留在你 shell 的历史记录中,所以认为这是一个天真的实现。凭证以 Base-64 编码的 JSON结构形式传递。

$ JSON=$(echo '{"username": "string", "password": "string", "serveraddress": "string"}' | base64)$ curl --unix-socket /var/run/docker.sock \  -H "Content-Type: application/tar" 
  -X POST "http:/v1.24/images/create?fromImage=alpine"  -H "X-Registry-Auth"  -d "$JSON"{"status":"Pulling from library/alpine","id":"3.1"}{"status":"Pulling fs layer","progressDetail":{},"id":"8f13703509f7"}{"status":"Downloading","progressDetail":{"current":32768,"total":2244027},"progress":"[\u003e                                                  ] 32.77 kB/2.244 MB","id":"8f13703509f7"}...

提交容器

提交容器以从其内容创建图像:

  • Python

  • Go

  • Curl

import docker
client = docker.from_env()container = client.containers.run("alpine", ["touch", "/helloworld"], detach=True)container.wait()image = container.commit("helloworld")print image.id
package mainimport (  "fmt"  "github.com/docker/docker/api/types"  "github.com/docker/docker/api/types/container"  "github.com/docker/docker/client"  "golang.org/x/net/context")func main() {
  ctx := context.Background()
  cli, err := client.NewEnvClient()  if err != nil {    panic(err)  }

  createResp, err := cli.ContainerCreate(ctx, &container.Config{
    Image: "alpine",
    Cmd:   []string{"touch", "/helloworld"},  }, nil, nil, "")  if err != nil {    panic(err)  }  if err := cli.ContainerStart(ctx, createResp.ID, types.ContainerStartOptions{}); err != nil {    panic(err)  }  if _, err = cli.ContainerWait(ctx, createResp.ID); err != nil {    panic(err)  }

  commitResp, err := cli.ContainerCommit(ctx, createResp.ID, types.ContainerCommitOptions{Reference: "helloworld"})  if err != nil {    panic(err)  }

  fmt.Println(commitResp.ID)}
$ docker run -d alpine touch /helloworld
0888269a9d584f0fa8fc96b3c0d8d57969ceea3a64acf47cd34eebb4744dbc52
$ curl --unix-socket /var/run/docker.sock\  -X POST "http:/v1.24/commit?container=0888269a9d&repo=helloworld"{"Id":"sha256:6c86a5cd4b87f2771648ce619e319f3e508394b5bfc2cdbd2d60f59d52acda6c"}

下一步

  • Python SDK的完整文档

  • Go SDK的完整文档

  • HTTPAPI的完整文档

Previous article: Next article: