mirror of
https://github.com/moby/moby.git
synced 2022-11-09 12:21:53 -05:00
Update docs/reference/api to complete the docs
Signed-off-by: tracylihui <793912329@qq.com>
This commit is contained in:
tracylihui
parent
df3ede95eb
commit
cc2ff8c921
6 changed files with 135 additions and 135 deletions
|
|
@ -180,7 +180,7 @@ Status Codes:
|
|||
|
||||
### Inspect a container
|
||||
|
||||
`GET /containers/(id)/json`
|
||||
`GET /containers/(id or name)/json`
|
||||
|
||||
Return low-level information on the container `id`
|
||||
|
||||
|
|
@ -267,7 +267,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
|
||||
|
|
@ -331,7 +331,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``
|
||||
|
||||
|
|
@ -364,7 +364,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
|
||||
|
||||
|
|
@ -400,7 +400,7 @@ Status Codes:
|
|||
|
||||
### Export a container
|
||||
|
||||
`GET /containers/(id)/export`
|
||||
`GET /containers/(id or name)/export`
|
||||
|
||||
Export the contents of container `id`
|
||||
|
||||
|
|
@ -423,13 +423,13 @@ Status Codes:
|
|||
|
||||
### Start a container
|
||||
|
||||
`POST /containers/(id)/start`
|
||||
`POST /containers/(id or name)/start`
|
||||
|
||||
Start the container `id`
|
||||
|
||||
**Example request**:
|
||||
|
||||
POST /containers/(id)/start HTTP/1.1
|
||||
POST /containers/(id or name)/start HTTP/1.1
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
|
|
@ -462,7 +462,7 @@ Status Codes:
|
|||
|
||||
### Stop a container
|
||||
|
||||
`POST /containers/(id)/stop`
|
||||
`POST /containers/(id or name)/stop`
|
||||
|
||||
Stop the container `id`
|
||||
|
||||
|
|
@ -487,7 +487,7 @@ Status Codes:
|
|||
|
||||
### Restart a container
|
||||
|
||||
`POST /containers/(id)/restart`
|
||||
`POST /containers/(id or name)/restart`
|
||||
|
||||
Restart the container `id`
|
||||
|
||||
|
|
@ -511,7 +511,7 @@ Status Codes:
|
|||
|
||||
### Kill a container
|
||||
|
||||
`POST /containers/(id)/kill`
|
||||
`POST /containers/(id or name)/kill`
|
||||
|
||||
Kill the container `id`
|
||||
|
||||
|
|
@ -536,7 +536,7 @@ Status Codes:
|
|||
|
||||
### Pause a container
|
||||
|
||||
`POST /containers/(id)/pause`
|
||||
`POST /containers/(id or name)/pause`
|
||||
|
||||
Pause the container `id`
|
||||
|
||||
|
|
@ -556,7 +556,7 @@ Status Codes:
|
|||
|
||||
### Unpause a container
|
||||
|
||||
`POST /containers/(id)/unpause`
|
||||
`POST /containers/(id or name)/unpause`
|
||||
|
||||
Unpause the container `id`
|
||||
|
||||
|
|
@ -576,7 +576,7 @@ Status Codes:
|
|||
|
||||
### Attach to a container
|
||||
|
||||
`POST /containers/(id)/attach`
|
||||
`POST /containers/(id or name)/attach`
|
||||
|
||||
Attach to the container `id`
|
||||
|
||||
|
|
@ -654,7 +654,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
|
||||
|
||||
|
|
@ -689,7 +689,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
|
||||
|
||||
|
|
@ -712,7 +712,7 @@ Status Codes:
|
|||
|
||||
### Remove a container
|
||||
|
||||
`DELETE /containers/(id)`
|
||||
`DELETE /containers/(id or name)`
|
||||
|
||||
Remove the container `id` from the filesystem
|
||||
|
||||
|
|
@ -740,7 +740,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`
|
||||
|
||||
|
|
|
|||
|
|
@ -268,7 +268,7 @@ Status Codes:
|
|||
|
||||
### Inspect a container
|
||||
|
||||
`GET /containers/(id)/json`
|
||||
`GET /containers/(id or name)/json`
|
||||
|
||||
Return low-level information on the container `id`
|
||||
|
||||
|
|
@ -355,7 +355,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
|
||||
|
|
@ -419,7 +419,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``
|
||||
|
||||
|
|
@ -451,7 +451,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
|
||||
|
||||
|
|
@ -487,7 +487,7 @@ Status Codes:
|
|||
|
||||
### Export a container
|
||||
|
||||
`GET /containers/(id)/export`
|
||||
`GET /containers/(id or name)/export`
|
||||
|
||||
Export the contents of container `id`
|
||||
|
||||
|
|
@ -510,7 +510,7 @@ Status Codes:
|
|||
|
||||
### Resize a container TTY
|
||||
|
||||
`GET /containers/(id)/resize?h=<height>&w=<width>`
|
||||
`GET /containers/(id or name)/resize?h=<height>&w=<width>`
|
||||
|
||||
Resize the TTY of container `id`
|
||||
|
||||
|
|
@ -532,13 +532,13 @@ Status Codes:
|
|||
|
||||
### Start a container
|
||||
|
||||
`POST /containers/(id)/start`
|
||||
`POST /containers/(id or name)/start`
|
||||
|
||||
Start the container `id`
|
||||
|
||||
**Example request**:
|
||||
|
||||
POST /containers/(id)/start HTTP/1.1
|
||||
POST /containers/(id or name)/start HTTP/1.1
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
|
|
@ -610,7 +610,7 @@ Status Codes:
|
|||
|
||||
### Stop a container
|
||||
|
||||
`POST /containers/(id)/stop`
|
||||
`POST /containers/(id or name)/stop`
|
||||
|
||||
Stop the container `id`
|
||||
|
||||
|
|
@ -635,7 +635,7 @@ Status Codes:
|
|||
|
||||
### Restart a container
|
||||
|
||||
`POST /containers/(id)/restart`
|
||||
`POST /containers/(id or name)/restart`
|
||||
|
||||
Restart the container `id`
|
||||
|
||||
|
|
@ -659,7 +659,7 @@ Status Codes:
|
|||
|
||||
### Kill a container
|
||||
|
||||
`POST /containers/(id)/kill`
|
||||
`POST /containers/(id or name)/kill`
|
||||
|
||||
Kill the container `id`
|
||||
|
||||
|
|
@ -684,7 +684,7 @@ Status Codes:
|
|||
|
||||
### Pause a container
|
||||
|
||||
`POST /containers/(id)/pause`
|
||||
`POST /containers/(id or name)/pause`
|
||||
|
||||
Pause the container `id`
|
||||
|
||||
|
|
@ -704,7 +704,7 @@ Status Codes:
|
|||
|
||||
### Unpause a container
|
||||
|
||||
`POST /containers/(id)/unpause`
|
||||
`POST /containers/(id or name)/unpause`
|
||||
|
||||
Unpause the container `id`
|
||||
|
||||
|
|
@ -724,7 +724,7 @@ Status Codes:
|
|||
|
||||
### Attach to a container
|
||||
|
||||
`POST /containers/(id)/attach`
|
||||
`POST /containers/(id or name)/attach`
|
||||
|
||||
Attach to the container `id`
|
||||
|
||||
|
|
@ -803,7 +803,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
|
||||
|
||||
|
|
@ -838,7 +838,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
|
||||
|
||||
|
|
@ -861,7 +861,7 @@ Status Codes:
|
|||
|
||||
### Remove a container
|
||||
|
||||
`DELETE /containers/(id)`
|
||||
`DELETE /containers/(id or name)`
|
||||
|
||||
Remove the container `id` from the filesystem
|
||||
|
||||
|
|
@ -889,7 +889,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`
|
||||
|
||||
|
|
@ -1623,7 +1623,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`
|
||||
|
||||
|
|
|
|||
|
|
@ -268,7 +268,7 @@ Status Codes:
|
|||
|
||||
### Inspect a container
|
||||
|
||||
`GET /containers/(id)/json`
|
||||
`GET /containers/(id or name)/json`
|
||||
|
||||
Return low-level information on the container `id`
|
||||
|
||||
|
|
@ -355,7 +355,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
|
||||
|
|
@ -419,7 +419,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``
|
||||
|
||||
|
|
@ -451,7 +451,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
|
||||
|
||||
|
|
@ -487,7 +487,7 @@ Status Codes:
|
|||
|
||||
### Export a container
|
||||
|
||||
`GET /containers/(id)/export`
|
||||
`GET /containers/(id or name)/export`
|
||||
|
||||
Export the contents of container `id`
|
||||
|
||||
|
|
@ -510,7 +510,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`. The container must be restarted for the resize to take effect.
|
||||
|
||||
|
|
@ -532,7 +532,7 @@ Status Codes:
|
|||
|
||||
### Start a container
|
||||
|
||||
`POST /containers/(id)/start`
|
||||
`POST /containers/(id or name)/start`
|
||||
|
||||
Start the container `id`
|
||||
|
||||
|
|
@ -542,7 +542,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**:
|
||||
|
||||
|
|
@ -557,7 +557,7 @@ Status Codes:
|
|||
|
||||
### Stop a container
|
||||
|
||||
`POST /containers/(id)/stop`
|
||||
`POST /containers/(id or name)/stop`
|
||||
|
||||
Stop the container `id`
|
||||
|
||||
|
|
@ -582,7 +582,7 @@ Status Codes:
|
|||
|
||||
### Restart a container
|
||||
|
||||
`POST /containers/(id)/restart`
|
||||
`POST /containers/(id or name)/restart`
|
||||
|
||||
Restart the container `id`
|
||||
|
||||
|
|
@ -606,7 +606,7 @@ Status Codes:
|
|||
|
||||
### Kill a container
|
||||
|
||||
`POST /containers/(id)/kill`
|
||||
`POST /containers/(id or name)/kill`
|
||||
|
||||
Kill the container `id`
|
||||
|
||||
|
|
@ -631,7 +631,7 @@ Status Codes:
|
|||
|
||||
### Pause a container
|
||||
|
||||
`POST /containers/(id)/pause`
|
||||
`POST /containers/(id or name)/pause`
|
||||
|
||||
Pause the container `id`
|
||||
|
||||
|
|
@ -651,7 +651,7 @@ Status Codes:
|
|||
|
||||
### Unpause a container
|
||||
|
||||
`POST /containers/(id)/unpause`
|
||||
`POST /containers/(id or name)/unpause`
|
||||
|
||||
Unpause the container `id`
|
||||
|
||||
|
|
@ -671,7 +671,7 @@ Status Codes:
|
|||
|
||||
### Attach to a container
|
||||
|
||||
`POST /containers/(id)/attach`
|
||||
`POST /containers/(id or name)/attach`
|
||||
|
||||
Attach to the container `id`
|
||||
|
||||
|
|
@ -751,7 +751,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
|
||||
|
||||
|
|
@ -786,7 +786,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
|
||||
|
||||
|
|
@ -809,7 +809,7 @@ Status Codes:
|
|||
|
||||
### Remove a container
|
||||
|
||||
`DELETE /containers/(id)`
|
||||
`DELETE /containers/(id or name)`
|
||||
|
||||
Remove the container `id` from the filesystem
|
||||
|
||||
|
|
@ -837,7 +837,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`
|
||||
|
||||
|
|
@ -1585,7 +1585,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`
|
||||
|
||||
|
|
|
|||
|
|
@ -272,7 +272,7 @@ Status Codes:
|
|||
|
||||
### Inspect a container
|
||||
|
||||
`GET /containers/(id)/json`
|
||||
`GET /containers/(id or name)/json`
|
||||
|
||||
Return low-level information on the container `id`
|
||||
|
||||
|
|
@ -394,7 +394,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
|
||||
|
|
@ -458,7 +458,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``
|
||||
|
||||
|
|
@ -493,7 +493,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
|
||||
|
||||
|
|
@ -529,7 +529,7 @@ Status Codes:
|
|||
|
||||
### Export a container
|
||||
|
||||
`GET /containers/(id)/export`
|
||||
`GET /containers/(id or name)/export`
|
||||
|
||||
Export the contents of container `id`
|
||||
|
||||
|
|
@ -552,7 +552,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.
|
||||
|
||||
|
|
@ -640,7 +640,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`. The container must be restarted for the resize to take effect.
|
||||
|
||||
|
|
@ -662,7 +662,7 @@ Status Codes:
|
|||
|
||||
### Start a container
|
||||
|
||||
`POST /containers/(id)/start`
|
||||
`POST /containers/(id or name)/start`
|
||||
|
||||
Start the container `id`
|
||||
|
||||
|
|
@ -672,7 +672,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**:
|
||||
|
||||
|
|
@ -687,7 +687,7 @@ Status Codes:
|
|||
|
||||
### Stop a container
|
||||
|
||||
`POST /containers/(id)/stop`
|
||||
`POST /containers/(id or name)/stop`
|
||||
|
||||
Stop the container `id`
|
||||
|
||||
|
|
@ -712,7 +712,7 @@ Status Codes:
|
|||
|
||||
### Restart a container
|
||||
|
||||
`POST /containers/(id)/restart`
|
||||
`POST /containers/(id or name)/restart`
|
||||
|
||||
Restart the container `id`
|
||||
|
||||
|
|
@ -736,7 +736,7 @@ Status Codes:
|
|||
|
||||
### Kill a container
|
||||
|
||||
`POST /containers/(id)/kill`
|
||||
`POST /containers/(id or name)/kill`
|
||||
|
||||
Kill the container `id`
|
||||
|
||||
|
|
@ -761,7 +761,7 @@ Status Codes:
|
|||
|
||||
### Rename a container
|
||||
|
||||
`POST /containers/(id)/rename`
|
||||
`POST /containers/(id or name)/rename`
|
||||
|
||||
Rename the container `id` to a `new_name`
|
||||
|
||||
|
|
@ -786,7 +786,7 @@ Status Codes:
|
|||
|
||||
### Pause a container
|
||||
|
||||
`POST /containers/(id)/pause`
|
||||
`POST /containers/(id or name)/pause`
|
||||
|
||||
Pause the container `id`
|
||||
|
||||
|
|
@ -806,7 +806,7 @@ Status Codes:
|
|||
|
||||
### Unpause a container
|
||||
|
||||
`POST /containers/(id)/unpause`
|
||||
`POST /containers/(id or name)/unpause`
|
||||
|
||||
Unpause the container `id`
|
||||
|
||||
|
|
@ -826,7 +826,7 @@ Status Codes:
|
|||
|
||||
### Attach to a container
|
||||
|
||||
`POST /containers/(id)/attach`
|
||||
`POST /containers/(id or name)/attach`
|
||||
|
||||
Attach to the container `id`
|
||||
|
||||
|
|
@ -909,7 +909,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
|
||||
|
||||
|
|
@ -944,7 +944,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
|
||||
|
||||
|
|
@ -967,7 +967,7 @@ Status Codes:
|
|||
|
||||
### Remove a container
|
||||
|
||||
`DELETE /containers/(id)`
|
||||
`DELETE /containers/(id or name)`
|
||||
|
||||
Remove the container `id` from the filesystem
|
||||
|
||||
|
|
@ -995,7 +995,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`
|
||||
|
||||
|
|
@ -1748,7 +1748,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`
|
||||
|
||||
|
|
@ -2005,4 +2005,4 @@ This might change in the future.
|
|||
To set cross origin requests to the remote api, please add flag "--api-enable-cors"
|
||||
when running docker in daemon mode.
|
||||
|
||||
$ docker -d -H="192.168.1.9:2375" --api-enable-cors
|
||||
$ docker -d -H="192.168.1.9:2375" --api-enable-cors
|
||||
|
|
|
|||
|
|
@ -299,7 +299,7 @@ Status Codes:
|
|||
|
||||
### Inspect a container
|
||||
|
||||
`GET /containers/(id)/json`
|
||||
`GET /containers/(id or name)/json`
|
||||
|
||||
Return low-level information on the container `id`
|
||||
|
||||
|
|
@ -432,7 +432,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
|
||||
|
|
@ -496,7 +496,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``
|
||||
|
||||
|
|
@ -534,7 +534,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
|
||||
|
||||
|
|
@ -576,7 +576,7 @@ Status Codes:
|
|||
|
||||
### Export a container
|
||||
|
||||
`GET /containers/(id)/export`
|
||||
`GET /containers/(id or name)/export`
|
||||
|
||||
Export the contents of container `id`
|
||||
|
||||
|
|
@ -599,7 +599,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.
|
||||
|
||||
|
|
@ -687,7 +687,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`. The container must be restarted for the resize to take effect.
|
||||
|
||||
|
|
@ -709,7 +709,7 @@ Status Codes:
|
|||
|
||||
### Start a container
|
||||
|
||||
`POST /containers/(id)/start`
|
||||
`POST /containers/(id or name)/start`
|
||||
|
||||
Start the container `id`
|
||||
|
||||
|
|
@ -719,7 +719,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**:
|
||||
|
||||
|
|
@ -734,7 +734,7 @@ Status Codes:
|
|||
|
||||
### Stop a container
|
||||
|
||||
`POST /containers/(id)/stop`
|
||||
`POST /containers/(id or name)/stop`
|
||||
|
||||
Stop the container `id`
|
||||
|
||||
|
|
@ -759,7 +759,7 @@ Status Codes:
|
|||
|
||||
### Restart a container
|
||||
|
||||
`POST /containers/(id)/restart`
|
||||
`POST /containers/(id or name)/restart`
|
||||
|
||||
Restart the container `id`
|
||||
|
||||
|
|
@ -783,7 +783,7 @@ Status Codes:
|
|||
|
||||
### Kill a container
|
||||
|
||||
`POST /containers/(id)/kill`
|
||||
`POST /containers/(id or name)/kill`
|
||||
|
||||
Kill the container `id`
|
||||
|
||||
|
|
@ -808,7 +808,7 @@ Status Codes:
|
|||
|
||||
### Rename a container
|
||||
|
||||
`POST /containers/(id)/rename`
|
||||
`POST /containers/(id or name)/rename`
|
||||
|
||||
Rename the container `id` to a `new_name`
|
||||
|
||||
|
|
@ -833,7 +833,7 @@ Status Codes:
|
|||
|
||||
### Pause a container
|
||||
|
||||
`POST /containers/(id)/pause`
|
||||
`POST /containers/(id or name)/pause`
|
||||
|
||||
Pause the container `id`
|
||||
|
||||
|
|
@ -853,7 +853,7 @@ Status Codes:
|
|||
|
||||
### Unpause a container
|
||||
|
||||
`POST /containers/(id)/unpause`
|
||||
`POST /containers/(id or name)/unpause`
|
||||
|
||||
Unpause the container `id`
|
||||
|
||||
|
|
@ -873,7 +873,7 @@ Status Codes:
|
|||
|
||||
### Attach to a container
|
||||
|
||||
`POST /containers/(id)/attach`
|
||||
`POST /containers/(id or name)/attach`
|
||||
|
||||
Attach to the container `id`
|
||||
|
||||
|
|
@ -956,7 +956,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
|
||||
|
||||
|
|
@ -991,7 +991,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
|
||||
|
||||
|
|
@ -1014,7 +1014,7 @@ Status Codes:
|
|||
|
||||
### Remove a container
|
||||
|
||||
`DELETE /containers/(id)`
|
||||
`DELETE /containers/(id or name)`
|
||||
|
||||
Remove the container `id` from the filesystem
|
||||
|
||||
|
|
@ -1042,7 +1042,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`
|
||||
|
||||
|
|
@ -1194,12 +1194,12 @@ or being killed.
|
|||
|
||||
Query Parameters:
|
||||
|
||||
- **dockerfile** - path within the build context to the Dockerfile. This is
|
||||
- **dockerfile** - path within the build context to the Dockerfile. This is
|
||||
ignored if `remote` is specified and points to an individual filename.
|
||||
- **t** – repository name (and optionally a tag) to be applied to
|
||||
the resulting image in case of success
|
||||
- **remote** – A Git repository URI or HTTP/HTTPS URI build source. If the
|
||||
URI specifies a filename, the file's contents are placed into a file
|
||||
- **remote** – A Git repository URI or HTTP/HTTPS URI build source. If the
|
||||
URI specifies a filename, the file's contents are placed into a file
|
||||
called `Dockerfile`.
|
||||
- **q** – suppress verbose build output
|
||||
- **nocache** – do not use the cache when building the image
|
||||
|
|
@ -1599,7 +1599,7 @@ Display system-wide information
|
|||
"SwapLimit": 0,
|
||||
"SystemTime": "2015-03-10T11:11:23.730591467-07:00"
|
||||
}
|
||||
|
||||
|
||||
Status Codes:
|
||||
|
||||
- **200** – no error
|
||||
|
|
@ -1866,7 +1866,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`
|
||||
|
||||
|
|
@ -2118,7 +2118,7 @@ This might change in the future.
|
|||
|
||||
## 3.3 CORS Requests
|
||||
|
||||
To set cross origin requests to the remote api please give values to
|
||||
To set cross origin requests to the remote api please give values to
|
||||
"--api-cors-header" when running docker in daemon mode. Set * will allow all,
|
||||
default or blank means CORS disabled
|
||||
|
||||
|
|
|
|||
|
|
@ -220,7 +220,7 @@ Json Parameters:
|
|||
(ie. the relative weight vs other containers).
|
||||
- **CpuPeriod** - The length of a CPU period in microseconds.
|
||||
- **CpuQuota** - Microseconds of CPU time that the container can get in a CPU period.
|
||||
- **Cpuset** - Deprecated please don't use. Use `CpusetCpus` instead.
|
||||
- **Cpuset** - Deprecated please don't use. Use `CpusetCpus` instead.
|
||||
- **CpusetCpus** - String value containing the `cgroups CpusetCpus` to use.
|
||||
- **CpusetMems** - Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems.
|
||||
- **BlkioWeight** - Block IO weight (relative weight) accepts a weight value between 10 and 1000.
|
||||
|
|
@ -310,7 +310,7 @@ Status Codes:
|
|||
|
||||
### Inspect a container
|
||||
|
||||
`GET /containers/(id)/json`
|
||||
`GET /containers/(id or name)/json`
|
||||
|
||||
Return low-level information on the container `id`
|
||||
|
||||
|
|
@ -447,7 +447,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
|
||||
|
|
@ -511,7 +511,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``
|
||||
|
||||
|
|
@ -551,7 +551,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
|
||||
|
||||
|
|
@ -593,7 +593,7 @@ Status Codes:
|
|||
|
||||
### Export a container
|
||||
|
||||
`GET /containers/(id)/export`
|
||||
`GET /containers/(id or name)/export`
|
||||
|
||||
Export the contents of container `id`
|
||||
|
||||
|
|
@ -616,7 +616,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.
|
||||
|
||||
|
|
@ -708,7 +708,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.
|
||||
|
||||
|
|
@ -730,7 +730,7 @@ Status Codes:
|
|||
|
||||
### Start a container
|
||||
|
||||
`POST /containers/(id)/start`
|
||||
`POST /containers/(id or name)/start`
|
||||
|
||||
Start the container `id`
|
||||
|
||||
|
|
@ -740,7 +740,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**:
|
||||
|
||||
|
|
@ -755,7 +755,7 @@ Status Codes:
|
|||
|
||||
### Stop a container
|
||||
|
||||
`POST /containers/(id)/stop`
|
||||
`POST /containers/(id or name)/stop`
|
||||
|
||||
Stop the container `id`
|
||||
|
||||
|
|
@ -780,7 +780,7 @@ Status Codes:
|
|||
|
||||
### Restart a container
|
||||
|
||||
`POST /containers/(id)/restart`
|
||||
`POST /containers/(id or name)/restart`
|
||||
|
||||
Restart the container `id`
|
||||
|
||||
|
|
@ -804,7 +804,7 @@ Status Codes:
|
|||
|
||||
### Kill a container
|
||||
|
||||
`POST /containers/(id)/kill`
|
||||
`POST /containers/(id or name)/kill`
|
||||
|
||||
Kill the container `id`
|
||||
|
||||
|
|
@ -829,7 +829,7 @@ Status Codes:
|
|||
|
||||
### Rename a container
|
||||
|
||||
`POST /containers/(id)/rename`
|
||||
`POST /containers/(id or name)/rename`
|
||||
|
||||
Rename the container `id` to a `new_name`
|
||||
|
||||
|
|
@ -854,7 +854,7 @@ Status Codes:
|
|||
|
||||
### Pause a container
|
||||
|
||||
`POST /containers/(id)/pause`
|
||||
`POST /containers/(id or name)/pause`
|
||||
|
||||
Pause the container `id`
|
||||
|
||||
|
|
@ -874,7 +874,7 @@ Status Codes:
|
|||
|
||||
### Unpause a container
|
||||
|
||||
`POST /containers/(id)/unpause`
|
||||
`POST /containers/(id or name)/unpause`
|
||||
|
||||
Unpause the container `id`
|
||||
|
||||
|
|
@ -894,7 +894,7 @@ Status Codes:
|
|||
|
||||
### Attach to a container
|
||||
|
||||
`POST /containers/(id)/attach`
|
||||
`POST /containers/(id or name)/attach`
|
||||
|
||||
Attach to the container `id`
|
||||
|
||||
|
|
@ -977,7 +977,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
|
||||
|
||||
|
|
@ -1012,7 +1012,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
|
||||
|
||||
|
|
@ -1035,7 +1035,7 @@ Status Codes:
|
|||
|
||||
### Remove a container
|
||||
|
||||
`DELETE /containers/(id)`
|
||||
`DELETE /containers/(id or name)`
|
||||
|
||||
Remove the container `id` from the filesystem
|
||||
|
||||
|
|
@ -1063,7 +1063,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`
|
||||
|
||||
|
|
@ -1365,37 +1365,37 @@ Return the history of the image `name`
|
|||
HTTP/1.1 200 OK
|
||||
Content-Type: application/json
|
||||
|
||||
[
|
||||
{
|
||||
[
|
||||
{
|
||||
"Id": "3db9c44f45209632d6050b35958829c3a2aa256d81b9a7be45b362ff85c54710",
|
||||
"Created": 1398108230,
|
||||
"CreatedBy": "/bin/sh -c #(nop) ADD file:eb15dbd63394e063b805a3c32ca7bf0266ef64676d5a6fab4801f2e81e2a5148 in /",
|
||||
"Tags": [
|
||||
"ubuntu:lucid",
|
||||
"ubuntu:10.04"
|
||||
],
|
||||
],
|
||||
"Size": 182964289,
|
||||
"Comment": ""
|
||||
},
|
||||
{
|
||||
},
|
||||
{
|
||||
"Id": "6cfa4d1f33fb861d4d114f43b25abd0ac737509268065cdfd69d544a59c85ab8",
|
||||
"Created": 1398108222,
|
||||
"CreatedBy": "/bin/sh -c #(nop) MAINTAINER Tianon Gravi <admwiggin@gmail.com> - mkimage-debootstrap.sh -i iproute,iputils-ping,ubuntu-minimal -t lucid.tar.xz lucid http://archive.ubuntu.com/ubuntu/",
|
||||
"Tags": null,
|
||||
"Size": 0,
|
||||
"Comment": ""
|
||||
},
|
||||
{
|
||||
},
|
||||
{
|
||||
"Id": "511136ea3c5a64f264b78b5433614aec563103b4d4702f3ba7d4d2698e22c158",
|
||||
"Created": 1371157430,
|
||||
"CreatedBy": "",
|
||||
"Tags": [
|
||||
"scratch12:latest",
|
||||
"scratch:latest"
|
||||
],
|
||||
],
|
||||
"Size": 0,
|
||||
"Comment": "Imported from -"
|
||||
}
|
||||
}
|
||||
]
|
||||
|
||||
Status Codes:
|
||||
|
|
@ -1932,7 +1932,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`
|
||||
|
||||
|
|
@ -2182,7 +2182,7 @@ from **200 OK** to **101 UPGRADED** and resends the same headers.
|
|||
|
||||
## 3.3 CORS Requests
|
||||
|
||||
To set cross origin requests to the remote api please give values to
|
||||
To set cross origin requests to the remote api please give values to
|
||||
`--api-cors-header` when running Docker in daemon mode. Set * (asterisk) allows all,
|
||||
default or blank means CORS disabled
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue