浏览代码

Added docs

Victor Vieux 12 年之前
父节点
当前提交
123c80467b
共有 2 个文件被更改,包括 35 次插入0 次删除
  1. 4 0
      docs/sources/api/docker_remote_api.rst
  2. 31 0
      docs/sources/api/docker_remote_api_v1.4.rst

+ 4 - 0
docs/sources/api/docker_remote_api.rst

@@ -48,6 +48,10 @@ What's new
 
    **New!** You can now use ps args with docker top, like `docker top <container_id> aux`
 
+.. http:get:: /events:
+
+   **New!** Image's name added in the events
+
 :doc:`docker_remote_api_v1.3`
 *****************************
 

+ 31 - 0
docs/sources/api/docker_remote_api_v1.4.rst

@@ -1095,6 +1095,37 @@ Create a new image from a container's changes
 	:statuscode 404: no such container
         :statuscode 500: server error
 
+
+Monitor Docker's events
+***********************
+
+.. http:get:: /events
+
+	Get events from docker, either in real time via streaming, or via polling (using `since`)
+
+	**Example request**:
+
+	.. sourcecode:: http
+
+           POST /events?since=1374067924
+
+        **Example response**:
+
+        .. sourcecode:: http
+
+           HTTP/1.1 200 OK
+	   Content-Type: application/json
+
+	   {"status":"create","id":"dfdf82bd3881","from":"base:latest","time":1374067924}
+	   {"status":"start","id":"dfdf82bd3881","from":"base:latest","time":1374067924}
+	   {"status":"stop","id":"dfdf82bd3881","from":"base:latest","time":1374067966}
+	   {"status":"destroy","id":"dfdf82bd3881","from":"base:latest","time":1374067970}
+
+	:query since: timestamp used for polling
+        :statuscode 200: no error
+        :statuscode 500: server error
+
+
 3. Going further
 ================