Merge pull request #20542 from longliqiang88/master2.201
Update doc docker_remote_api_v1.20.md
This commit is contained in:
Vincent Demeester
commit
41a2bac7cf
1 changed files with 24 additions and 24 deletions
|
|
@ -318,7 +318,7 @@ Status Codes:
|
|||
|
||||
### Inspect a container
|
||||
|
||||
`GET /containers/(id)/json`
|
||||
`GET /containers/(id or name)/json`
|
||||
|
||||
Return low-level information on the container `id`
|
||||
|
||||
|
|
@ -460,7 +460,7 @@ Status Codes:
|
|||
|
||||
### List processes running inside a container
|
||||
|
||||
`GET /containers/(id)/top`
|
||||
`GET /containers/(id or name)/top`
|
||||
|
||||
List processes running inside the container `id`. On Unix systems this
|
||||
is done by running the `ps` command. This endpoint is not
|
||||
|
|
@ -524,7 +524,7 @@ Status Codes:
|
|||
|
||||
### Get container logs
|
||||
|
||||
`GET /containers/(id)/logs`
|
||||
`GET /containers/(id or name)/logs`
|
||||
|
||||
Get `stdout` and `stderr` logs from the container ``id``
|
||||
|
||||
|
|
@ -564,7 +564,7 @@ Status Codes:
|
|||
|
||||
### Inspect changes on a container's filesystem
|
||||
|
||||
`GET /containers/(id)/changes`
|
||||
`GET /containers/(id or name)/changes`
|
||||
|
||||
Inspect changes on container `id`'s filesystem
|
||||
|
||||
|
|
@ -606,7 +606,7 @@ Status Codes:
|
|||
|
||||
### Export a container
|
||||
|
||||
`GET /containers/(id)/export`
|
||||
`GET /containers/(id or name)/export`
|
||||
|
||||
Export the contents of container `id`
|
||||
|
||||
|
|
@ -629,7 +629,7 @@ Status Codes:
|
|||
|
||||
### Get container stats based on resource usage
|
||||
|
||||
`GET /containers/(id)/stats`
|
||||
`GET /containers/(id or name)/stats`
|
||||
|
||||
This endpoint returns a live stream of a container's resource usage statistics.
|
||||
|
||||
|
|
@ -721,7 +721,7 @@ Status Codes:
|
|||
|
||||
### Resize a container TTY
|
||||
|
||||
`POST /containers/(id)/resize?h=<height>&w=<width>`
|
||||
`POST /containers/(id or name)/resize?h=<height>&w=<width>`
|
||||
|
||||
Resize the TTY for container with `id`. You must restart the container for the resize to take effect.
|
||||
|
||||
|
|
@ -743,7 +743,7 @@ Status Codes:
|
|||
|
||||
### Start a container
|
||||
|
||||
`POST /containers/(id)/start`
|
||||
`POST /containers/(id or name)/start`
|
||||
|
||||
Start the container `id`
|
||||
|
||||
|
|
@ -753,7 +753,7 @@ Start the container `id`
|
|||
|
||||
**Example request**:
|
||||
|
||||
POST /containers/(id)/start HTTP/1.1
|
||||
POST /containers/(id or name)/start HTTP/1.1
|
||||
|
||||
**Example response**:
|
||||
|
||||
|
|
@ -768,7 +768,7 @@ Status Codes:
|
|||
|
||||
### Stop a container
|
||||
|
||||
`POST /containers/(id)/stop`
|
||||
`POST /containers/(id or name)/stop`
|
||||
|
||||
Stop the container `id`
|
||||
|
||||
|
|
@ -793,7 +793,7 @@ Status Codes:
|
|||
|
||||
### Restart a container
|
||||
|
||||
`POST /containers/(id)/restart`
|
||||
`POST /containers/(id or name)/restart`
|
||||
|
||||
Restart the container `id`
|
||||
|
||||
|
|
@ -817,7 +817,7 @@ Status Codes:
|
|||
|
||||
### Kill a container
|
||||
|
||||
`POST /containers/(id)/kill`
|
||||
`POST /containers/(id or name)/kill`
|
||||
|
||||
Kill the container `id`
|
||||
|
||||
|
|
@ -842,7 +842,7 @@ Status Codes:
|
|||
|
||||
### Rename a container
|
||||
|
||||
`POST /containers/(id)/rename`
|
||||
`POST /containers/(id or name)/rename`
|
||||
|
||||
Rename the container `id` to a `new_name`
|
||||
|
||||
|
|
@ -867,7 +867,7 @@ Status Codes:
|
|||
|
||||
### Pause a container
|
||||
|
||||
`POST /containers/(id)/pause`
|
||||
`POST /containers/(id or name)/pause`
|
||||
|
||||
Pause the container `id`
|
||||
|
||||
|
|
@ -887,7 +887,7 @@ Status Codes:
|
|||
|
||||
### Unpause a container
|
||||
|
||||
`POST /containers/(id)/unpause`
|
||||
`POST /containers/(id or name)/unpause`
|
||||
|
||||
Unpause the container `id`
|
||||
|
||||
|
|
@ -907,7 +907,7 @@ Status Codes:
|
|||
|
||||
### Attach to a container
|
||||
|
||||
`POST /containers/(id)/attach`
|
||||
`POST /containers/(id or name)/attach`
|
||||
|
||||
Attach to the container `id`
|
||||
|
||||
|
|
@ -990,7 +990,7 @@ Status Codes:
|
|||
|
||||
### Attach to a container (websocket)
|
||||
|
||||
`GET /containers/(id)/attach/ws`
|
||||
`GET /containers/(id or name)/attach/ws`
|
||||
|
||||
Attach to the container `id` via websocket
|
||||
|
||||
|
|
@ -1025,7 +1025,7 @@ Status Codes:
|
|||
|
||||
### Wait a container
|
||||
|
||||
`POST /containers/(id)/wait`
|
||||
`POST /containers/(id or name)/wait`
|
||||
|
||||
Block until container `id` stops, then returns the exit code
|
||||
|
||||
|
|
@ -1048,7 +1048,7 @@ Status Codes:
|
|||
|
||||
### Remove a container
|
||||
|
||||
`DELETE /containers/(id)`
|
||||
`DELETE /containers/(id or name)`
|
||||
|
||||
Remove the container `id` from the filesystem
|
||||
|
||||
|
|
@ -1076,7 +1076,7 @@ Status Codes:
|
|||
|
||||
### Copy files or folders from a container
|
||||
|
||||
`POST /containers/(id)/copy`
|
||||
`POST /containers/(id or name)/copy`
|
||||
|
||||
Copy files or folders of container `id`
|
||||
|
||||
|
|
@ -1106,14 +1106,14 @@ Status Codes:
|
|||
|
||||
### Retrieving information about files and folders in a container
|
||||
|
||||
`HEAD /containers/(id)/archive`
|
||||
`HEAD /containers/(id or name)/archive`
|
||||
|
||||
See the description of the `X-Docker-Container-Path-Stat` header in the
|
||||
following section.
|
||||
|
||||
### Get an archive of a filesystem resource in a container
|
||||
|
||||
`GET /containers/(id)/archive`
|
||||
`GET /containers/(id or name)/archive`
|
||||
|
||||
Get an tar archive of a resource in the filesystem of container `id`.
|
||||
|
||||
|
|
@ -1174,7 +1174,7 @@ Status Codes:
|
|||
|
||||
### Extract an archive of files or folders to a directory in a container
|
||||
|
||||
`PUT /containers/(id)/archive`
|
||||
`PUT /containers/(id or name)/archive`
|
||||
|
||||
Upload a tar archive to be extracted to a path in the filesystem of container
|
||||
`id`.
|
||||
|
|
@ -2078,7 +2078,7 @@ the root that contains a list of repository and tag names mapped to layer IDs.
|
|||
|
||||
### Exec Create
|
||||
|
||||
`POST /containers/(id)/exec`
|
||||
`POST /containers/(id or name)/exec`
|
||||
|
||||
Sets up an exec instance in a running container `id`
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue