浏览代码

Update docker_remote_api_v1.21.md to complete the docs

Signed-off-by: tracylihui <793912329@qq.com>
tracylihui 9 年之前
父节点
当前提交
df3ede95eb
共有 1 个文件被更改,包括 24 次插入24 次删除
  1. 24 24
      docs/reference/api/docker_remote_api_v1.21.md

+ 24 - 24
docs/reference/api/docker_remote_api_v1.21.md

@@ -336,7 +336,7 @@ Status Codes:
 
 
 ### Inspect a container
 ### Inspect a container
 
 
-`GET /containers/(id)/json`
+`GET /containers/(id or name)/json`
 
 
 Return low-level information on the container `id`
 Return low-level information on the container `id`
 
 
@@ -526,7 +526,7 @@ Status Codes:
 
 
 ### List processes running inside a container
 ### 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
 List processes running inside the container `id`. On Unix systems this
 is done by running the `ps` command. This endpoint is not
 is done by running the `ps` command. This endpoint is not
@@ -590,7 +590,7 @@ Status Codes:
 
 
 ### Get container logs
 ### Get container logs
 
 
-`GET /containers/(id)/logs`
+`GET /containers/(id or name)/logs`
 
 
 Get `stdout` and `stderr` logs from the container ``id``
 Get `stdout` and `stderr` logs from the container ``id``
 
 
@@ -630,7 +630,7 @@ Status Codes:
 
 
 ### Inspect changes on a container's filesystem
 ### Inspect changes on a container's filesystem
 
 
-`GET /containers/(id)/changes`
+`GET /containers/(id or name)/changes`
 
 
 Inspect changes on container `id`'s filesystem
 Inspect changes on container `id`'s filesystem
 
 
@@ -672,7 +672,7 @@ Status Codes:
 
 
 ### Export a container
 ### Export a container
 
 
-`GET /containers/(id)/export`
+`GET /containers/(id or name)/export`
 
 
 Export the contents of container `id`
 Export the contents of container `id`
 
 
@@ -695,7 +695,7 @@ Status Codes:
 
 
 ### Get container stats based on resource usage
 ### 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.
 This endpoint returns a live stream of a container's resource usage statistics.
 
 
@@ -799,7 +799,7 @@ Status Codes:
 
 
 ### Resize a container TTY
 ### Resize a container TTY
 
 
-`POST /containers/(id)/resize`
+`POST /containers/(id or name)/resize`
 
 
 Resize the TTY for container with  `id`. The unit is number of characters. You must restart the container for the resize to take effect.
 Resize the TTY for container with  `id`. The unit is number of characters. You must restart the container for the resize to take effect.
 
 
@@ -826,7 +826,7 @@ Status Codes:
 
 
 ### Start a container
 ### Start a container
 
 
-`POST /containers/(id)/start`
+`POST /containers/(id or name)/start`
 
 
 Start the container `id`
 Start the container `id`
 
 
@@ -836,7 +836,7 @@ Start the container `id`
 
 
 **Example request**:
 **Example request**:
 
 
-    POST /containers/(id)/start HTTP/1.1
+    POST /containers/(id or name)/start HTTP/1.1
 
 
 **Example response**:
 **Example response**:
 
 
@@ -851,7 +851,7 @@ Status Codes:
 
 
 ### Stop a container
 ### Stop a container
 
 
-`POST /containers/(id)/stop`
+`POST /containers/(id or name)/stop`
 
 
 Stop the container `id`
 Stop the container `id`
 
 
@@ -876,7 +876,7 @@ Status Codes:
 
 
 ### Restart a container
 ### Restart a container
 
 
-`POST /containers/(id)/restart`
+`POST /containers/(id or name)/restart`
 
 
 Restart the container `id`
 Restart the container `id`
 
 
@@ -900,7 +900,7 @@ Status Codes:
 
 
 ### Kill a container
 ### Kill a container
 
 
-`POST /containers/(id)/kill`
+`POST /containers/(id or name)/kill`
 
 
 Kill the container `id`
 Kill the container `id`
 
 
@@ -925,7 +925,7 @@ Status Codes:
 
 
 ### Rename a container
 ### Rename a container
 
 
-`POST /containers/(id)/rename`
+`POST /containers/(id or name)/rename`
 
 
 Rename the container `id` to a `new_name`
 Rename the container `id` to a `new_name`
 
 
@@ -950,7 +950,7 @@ Status Codes:
 
 
 ### Pause a container
 ### Pause a container
 
 
-`POST /containers/(id)/pause`
+`POST /containers/(id or name)/pause`
 
 
 Pause the container `id`
 Pause the container `id`
 
 
@@ -970,7 +970,7 @@ Status Codes:
 
 
 ### Unpause a container
 ### Unpause a container
 
 
-`POST /containers/(id)/unpause`
+`POST /containers/(id or name)/unpause`
 
 
 Unpause the container `id`
 Unpause the container `id`
 
 
@@ -990,7 +990,7 @@ Status Codes:
 
 
 ### Attach to a container
 ### Attach to a container
 
 
-`POST /containers/(id)/attach`
+`POST /containers/(id or name)/attach`
 
 
 Attach to the container `id`
 Attach to the container `id`
 
 
@@ -1073,7 +1073,7 @@ Status Codes:
 
 
 ### Attach to a container (websocket)
 ### Attach to a container (websocket)
 
 
-`GET /containers/(id)/attach/ws`
+`GET /containers/(id or name)/attach/ws`
 
 
 Attach to the container `id` via websocket
 Attach to the container `id` via websocket
 
 
@@ -1108,7 +1108,7 @@ Status Codes:
 
 
 ### Wait a container
 ### Wait a container
 
 
-`POST /containers/(id)/wait`
+`POST /containers/(id or name)/wait`
 
 
 Block until container `id` stops, then returns the exit code
 Block until container `id` stops, then returns the exit code
 
 
@@ -1131,7 +1131,7 @@ Status Codes:
 
 
 ### Remove a container
 ### Remove a container
 
 
-`DELETE /containers/(id)`
+`DELETE /containers/(id or name)`
 
 
 Remove the container `id` from the filesystem
 Remove the container `id` from the filesystem
 
 
@@ -1159,7 +1159,7 @@ Status Codes:
 
 
 ### Copy files or folders from a container
 ### Copy files or folders from a container
 
 
-`POST /containers/(id)/copy`
+`POST /containers/(id or name)/copy`
 
 
 Copy files or folders of container `id`
 Copy files or folders of container `id`
 
 
@@ -1189,14 +1189,14 @@ Status Codes:
 
 
 ### Retrieving information about files and folders in a container
 ### 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
 See the description of the `X-Docker-Container-Path-Stat` header in the
 following section.
 following section.
 
 
 ### Get an archive of a filesystem resource in a container
 ### 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`.
 Get an tar archive of a resource in the filesystem of container `id`.
 
 
@@ -1257,7 +1257,7 @@ Status Codes:
 
 
 ### Extract an archive of files or folders to a directory in a container
 ### 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
 Upload a tar archive to be extracted to a path in the filesystem of container
 `id`.
 `id`.
@@ -2232,7 +2232,7 @@ the root that contains a list of repository and tag names mapped to layer IDs.
 
 
 ### Exec Create
 ### Exec Create
 
 
-`POST /containers/(id)/exec`
+`POST /containers/(id or name)/exec`
 
 
 Sets up an exec instance in a running container `id`
 Sets up an exec instance in a running container `id`