docker
/
docs
mirror of https://github.com/docker/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #4245 from manuel-woelker/docs-remote-api 

Added some documentation for the JSON params in the /containers/create and /containers/(id)/start remote APIs
This commit is contained in:
Sven Dowideit 2014-02-22 10:15:20 +10:00
parent 75e62a60a2 c3faab3955
commit f36d455144
2 changed files with 30 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/sources/reference/api/docker_remote_api_v1.8.rst
View File

@ -118,6 +118,7 @@ Create a container
"User":"", "User":"",
"Memory":0, "Memory":0,
"MemorySwap":0, "MemorySwap":0,
"CpuShares":0,
"AttachStdin":false, "AttachStdin":false,
"AttachStdout":true, "AttachStdout":true,
"AttachStderr":true, "AttachStderr":true,
@ -153,7 +154,15 @@ Create a container
"Warnings":[] "Warnings":[]
} }
:jsonparam config: the container's configuration :jsonparam Hostname: Container host name
:jsonparam User: Username or UID
:jsonparam Memory: Memory Limit in bytes
:jsonparam CpuShares: CPU shares (relative weight)
:jsonparam AttachStdin: 1/True/true or 0/False/false, attach to standard input. Default false
:jsonparam AttachStdout: 1/True/true or 0/False/false, attach to standard output. Default false
:jsonparam AttachStderr: 1/True/true or 0/False/false, attach to standard error. Default false
:jsonparam Tty: 1/True/true or 0/False/false, allocate a pseudo-tty. Default false
:jsonparam OpenStdin: 1/True/true or 0/False/false, keep stdin open even if not attached. Default false
:query name: Assign the specified name to the container. Must match ``/?[a-zA-Z0-9_-]+``. :query name: Assign the specified name to the container. Must match ``/?[a-zA-Z0-9_-]+``.
:statuscode 201: no error :statuscode 201: no error
:statuscode 404: no such container :statuscode 404: no such container
@ -394,7 +403,11 @@ Start a container
HTTP/1.1 204 No Content HTTP/1.1 204 No Content
Content-Type: text/plain Content-Type: text/plain
:jsonparam hostConfig: the container's host configuration (optional) :jsonparam Binds: Create a bind mount to a directory or file with [host-path]:[container-path]:[rw|ro]. If a directory "container-path" is missing, then docker creates a new volume.
:jsonparam LxcConf: Map of custom lxc options
:jsonparam PortBindings: Expose ports from the container, optionally publishing them via the HostPort flag
:jsonparam PublishAllPorts: 1/True/true or 0/False/false, publish all exposed ports to the host interfaces. Default false
:jsonparam Privileged: 1/True/true or 0/False/false, give extended privileges to this container. Default false
:statuscode 204: no error :statuscode 204: no error
:statuscode 404: no such container :statuscode 404: no such container
:statuscode 500: server error :statuscode 500: server error

17
docs/sources/reference/api/docker_remote_api_v1.9.rst
View File

@ -118,6 +118,7 @@ Create a container
"User":"", "User":"",
"Memory":0, "Memory":0,
"MemorySwap":0, "MemorySwap":0,
"CpuShares":0,
"AttachStdin":false, "AttachStdin":false,
"AttachStdout":true, "AttachStdout":true,
"AttachStderr":true, "AttachStderr":true,
@ -153,7 +154,15 @@ Create a container
"Warnings":[] "Warnings":[]
} }
:jsonparam config: the container's configuration :jsonparam Hostname: Container host name
:jsonparam User: Username or UID
:jsonparam Memory: Memory Limit in bytes
:jsonparam CpuShares: CPU shares (relative weight)
:jsonparam AttachStdin: 1/True/true or 0/False/false, attach to standard input. Default false
:jsonparam AttachStdout: 1/True/true or 0/False/false, attach to standard output. Default false
:jsonparam AttachStderr: 1/True/true or 0/False/false, attach to standard error. Default false
:jsonparam Tty: 1/True/true or 0/False/false, allocate a pseudo-tty. Default false
:jsonparam OpenStdin: 1/True/true or 0/False/false, keep stdin open even if not attached. Default false
:query name: Assign the specified name to the container. Must match ``/?[a-zA-Z0-9_-]+``. :query name: Assign the specified name to the container. Must match ``/?[a-zA-Z0-9_-]+``.
:statuscode 201: no error :statuscode 201: no error
:statuscode 404: no such container :statuscode 404: no such container
@ -394,7 +403,11 @@ Start a container
HTTP/1.1 204 No Content HTTP/1.1 204 No Content
Content-Type: text/plain Content-Type: text/plain
:jsonparam hostConfig: the container's host configuration (optional) :jsonparam Binds: Create a bind mount to a directory or file with [host-path]:[container-path]:[rw|ro]. If a directory "container-path" is missing, then docker creates a new volume.
:jsonparam LxcConf: Map of custom lxc options
:jsonparam PortBindings: Expose ports from the container, optionally publishing them via the HostPort flag
:jsonparam PublishAllPorts: 1/True/true or 0/False/false, publish all exposed ports to the host interfaces. Default false
:jsonparam Privileged: 1/True/true or 0/False/false, give extended privileges to this container. Default false
:statuscode 204: no error :statuscode 204: no error
:statuscode 404: no such container :statuscode 404: no such container
:statuscode 500: server error :statuscode 500: server error