Commit 7122bc69 authored by Stavros Sachtouris's avatar Stavros Sachtouris
Browse files

Model a more descriptive docs on List Servers

parent b55c3ac2
...@@ -82,6 +82,12 @@ Servers ...@@ -82,6 +82,12 @@ Servers
List Servers List Servers
............ ............
.. rubric:: Semantics
List all virtual servers owned by the user.
.. rubric:: Request
=================== ====== ======== ========== =================== ====== ======== ==========
URI Method Cyclades OS Compute URI Method Cyclades OS Compute
=================== ====== ======== ========== =================== ====== ======== ==========
...@@ -93,6 +99,16 @@ URI Method Cyclades OS Compute ...@@ -93,6 +99,16 @@ URI Method Cyclades OS Compute
``name``, while the second returns the full collections of server ``name``, while the second returns the full collections of server
attributes. attributes.
|
============== ========================= ======== ==========
Request Header Value Cyclades OS Compute
============== ========================= ======== ==========
X-Auth-Token User authentication token required required
============== ========================= ======== ==========
|
================= =================================== ======== ========== ================= =================================== ======== ==========
Request Parameter Value Cyclades OS Compute Request Parameter Value Cyclades OS Compute
================= =================================== ======== ========== ================= =================================== ======== ==========
...@@ -114,15 +130,9 @@ the response will be formated in json. ...@@ -114,15 +130,9 @@ the response will be formated in json.
* **changes-since** must be an ISO8601 date string * **changes-since** must be an ISO8601 date string
| .. note:: Request body should be empty
============== ========================= ======== ==========
Request Header Value Cyclades OS Compute
============== ========================= ======== ==========
X-Auth-Token User authentication token required required
============== ========================= ======== ==========
| .. rubric:: Response
=========================== ===================== =========================== =====================
Return Code Description Return Code Description
...@@ -137,9 +147,17 @@ Return Code Description ...@@ -137,9 +147,17 @@ Return Code Description
503 (Service Unavailable) The server is not currently available 503 (Service Unavailable) The server is not currently available
=========================== ===================== =========================== =====================
|
The response data format is a list of servers under the ``servers`` label. A Response body contents::
server may have the fields presented bellow:
servers: [
{
<server attribute>: <value>,
<server attribute>: <value>,
...
}, ...
]
================= ====================== ======== ========== ================= ====================== ======== ==========
Server Attributes Description Cyclades OS Compute Server Attributes Description Cyclades OS Compute
...@@ -163,17 +181,14 @@ metadata Server custom metadata ✔ ✔ ...@@ -163,17 +181,14 @@ metadata Server custom metadata ✔ ✔
* **hostId** is not used in Cyclades, but is returned as an empty string for * **hostId** is not used in Cyclades, but is returned as an empty string for
compatibility compatibility
* **progress** is changing while the server is building up and has values * **progress** is changing while the server is building up and has values
between 0 and 100. When it reaches 100 the server is built. between 0 and 100. When it reaches 100 the server is built.
* **status** refers to `the status <#status-ref>`_ of the server * **status** refers to `the status <#status-ref>`_ of the server
* **metadata** are custom key:value pairs used to specify various attributes of * **metadata** are custom key:value pairs used to specify various attributes of
the VM (e.g. OS, super user, etc.) the VM (e.g. OS, super user, etc.)
* **attachments** in Cyclades are lists of network interfaces (nics). * **attachments** in Cyclades are lists of network interfaces (nics).
**Attachments** are different to OS Compute's **addresses**. The former is a **Attachments** are different to OS Compute's **addresses**. The former is a
list of the server's `network interface connections <#nic-ref>`_ while the list of the server's `network interface connections <#nic-ref>`_ while the
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment