Revision 6609821f docs/astakos-api-guide.rst
| b/docs/astakos-api-guide.rst | ||
|---|---|---|
| 20 | 20 |
========================= ================================ |
| 21 | 21 |
Revision Description |
| 22 | 22 |
========================= ================================ |
| 23 |
0.14 (May 14, 2013) Do not serve user quotas in :ref:`authenticate-api-label` |
|
| 23 | 24 |
0.14 (May 02, 2013) Change URIs (keep also the old ones until the next version) |
| 24 | 25 |
0.13 (January 21, 2013) Extend api to export user presentation & quota information. |
| 25 |
0.6 (June 06, 2012) Split service and admin API.
|
|
| 26 |
0.6 (June 06, 2012) Split service and user API.
|
|
| 26 | 27 |
0.1 (Feb 10, 2012) Initial release. |
| 27 | 28 |
========================= ================================ |
| 28 | 29 |
|
| ... | ... | |
| 77 | 78 |
.. warning:: The service is also available under ``/im/get_menu``. |
| 78 | 79 |
It will be removed in the next version. |
| 79 | 80 |
|
| 80 |
Admin API Operations
|
|
| 81 |
User API Operations
|
|
| 81 | 82 |
-------------------- |
| 82 | 83 |
|
| 83 | 84 |
The operations described in this chapter allow users to authenticate themselves, send feedback and get user uuid/displayname mappings. |
| ... | ... | |
| 105 | 106 |
X-Auth-Token User authentication token |
| 106 | 107 |
==================== =========================== |
| 107 | 108 |
|
| 108 |
| |
|
| 109 |
|
|
| 110 |
====================== ========================= |
|
| 111 |
Request Parameter Name Value |
|
| 112 |
====================== ========================= |
|
| 113 |
usage (optional) |
|
| 114 |
====================== ========================= |
|
| 115 |
|
|
| 116 | 109 |
Extended information on the user serialized in the json format will be returned: |
| 117 | 110 |
|
| 118 | 111 |
=========================== ============================ |
| ... | ... | |
| 127 | 120 |
usage List of user resource usage (if usage request parameter is present) |
| 128 | 121 |
=========================== ============================ |
| 129 | 122 |
|
| 130 |
Example reply without `usage` request parameter:
|
|
| 123 |
Example reply: |
|
| 131 | 124 |
|
| 132 | 125 |
:: |
| 133 | 126 |
|
| ... | ... | |
| 139 | 132 |
"auth_token_created": "Wed, 30 May 2012 10:03:37 GMT", |
| 140 | 133 |
"auth_token_expires": "Fri, 29 Jun 2012 10:03:37 GMT"} |
| 141 | 134 |
|
| 142 |
Example reply with `usage` request parameter: |
|
| 143 |
|
|
| 144 |
:: |
|
| 145 |
|
|
| 146 |
{"id": "12",
|
|
| 147 |
"displayname": "user@example.com", |
|
| 148 |
"uuid": "a9dc21d2-bcb2-4104-9a9e-402b7c70d6d8", |
|
| 149 |
"email": "[user@example.com]", |
|
| 150 |
"name": "Firstname Lastname", |
|
| 151 |
"auth_token_created": "Wed, 30 May 2012 10:03:37 GMT", |
|
| 152 |
"auth_token_expires": "Fri, 29 Jun 2012 10:03:37 GMT", |
|
| 153 |
"usage": [{"currValue": 4536392,
|
|
| 154 |
"display_name": "Storage Space", |
|
| 155 |
"description": "Pithos account diskspace", |
|
| 156 |
"verbose_name": "Storage Space", |
|
| 157 |
"help_text_input_each": "This is the total amount of space on Pithos that will be granted to each user of this Project ", "maxValue": 5368710653, |
|
| 158 |
"pluralized_display_name": "Storage Space", |
|
| 159 |
"report_desc": "Storage Space", |
|
| 160 |
"help_text": "This is the space on Pithos for storing files and VM Images. ", |
|
| 161 |
"is_abbreviation": false, |
|
| 162 |
"placeholder": "eg. 10GB", |
|
| 163 |
"unit": "bytes", |
|
| 164 |
"name": "pithos+.diskspace"}, |
|
| 165 |
{"currValue": 0,
|
|
| 166 |
"display_name": "System Disk", |
|
| 167 |
"description": "Virtual machine disk size", |
|
| 168 |
"verbose_name": "System Disk", |
|
| 169 |
"help_text_input_each": "This is the total amount of System Disk that will be granted to each user of this Project (this refers to the total System Disk of all VMs, not each VM's System Disk) ", |
|
| 170 |
"maxValue": 53687091200, |
|
| 171 |
"pluralized_display_name": "System Disk", |
|
| 172 |
"report_desc": "System Disk", |
|
| 173 |
"help_text": "This is the System Disk that the VMs have that run the OS ", |
|
| 174 |
"is_abbreviation": false, |
|
| 175 |
"placeholder": "eg. 5GB, 2GB etc", |
|
| 176 |
"unit": "bytes", |
|
| 177 |
"name": "cyclades.disk"}, |
|
| 178 |
{"currValue": 0,
|
|
| 179 |
"display_name": "CPU", |
|
| 180 |
"description": "Number of virtual machine processors", |
|
| 181 |
"verbose_name": "cpu", |
|
| 182 |
"help_text_input_each": "This is the total number of CPUs that will be granted to each user of this Project (on all VMs) ", "maxValue": 6, "pluralized_display_name": "CPUs", |
|
| 183 |
"report_desc": "CPUs", |
|
| 184 |
"help_text": "CPUs used by VMs ", |
|
| 185 |
"is_abbreviation": true, |
|
| 186 |
"placeholder": "eg. 1", |
|
| 187 |
"unit": "", |
|
| 188 |
"name": "cyclades.cpu"}, |
|
| 189 |
{"currValue": 0,
|
|
| 190 |
"display_name": "RAM", |
|
| 191 |
"description": "Virtual machines", |
|
| 192 |
"verbose_name": "ram", |
|
| 193 |
"help_text_input_each": "This is the total amount of RAM that will be granted to each user of this Project (on all VMs) ", "maxValue": 6442450944, |
|
| 194 |
"pluralized_display_name": "RAM", |
|
| 195 |
"report_desc": "RAM", |
|
| 196 |
"help_text": "RAM used by VMs ", |
|
| 197 |
"is_abbreviation": true, |
|
| 198 |
"placeholder": "eg. 4GB", |
|
| 199 |
"unit": "bytes", "name": "cyclades.ram"}, |
|
| 200 |
{"currValue": 0, "display_name": "VM",
|
|
| 201 |
"description": "Number of virtual machines", |
|
| 202 |
"verbose_name": "vm", "help_text_input_each": "This is the total number of VMs that will be granted to each user of this Project ", "maxValue": 2, |
|
| 203 |
"pluralized_display_name": "VMs", |
|
| 204 |
"report_desc": "Virtual Machines", |
|
| 205 |
"help_text": "These are the VMs one can create on the Cyclades UI ", |
|
| 206 |
"is_abbreviation": true, "placeholder": "eg. 2", |
|
| 207 |
"unit": "", |
|
| 208 |
"name": "cyclades.vm"}, |
|
| 209 |
{"currValue": 0,
|
|
| 210 |
"display_name": "private network", |
|
| 211 |
"description": "Private networks", |
|
| 212 |
"verbose_name": "private network", |
|
| 213 |
"help_text_input_each": "This is the total number of Private Networks that will be granted to each user of this Project ", |
|
| 214 |
"maxValue": 1, |
|
| 215 |
"pluralized_display_name": "private networks", |
|
| 216 |
"report_desc": "Private Networks", |
|
| 217 |
"help_text": "These are the Private Networks one can create on the Cyclades UI. ", |
|
| 218 |
"is_abbreviation": false, |
|
| 219 |
"placeholder": "eg. 1", |
|
| 220 |
"unit": "", |
|
| 221 |
"name": "cyclades.network.private"}]} |
|
| 222 |
|
|
| 223 |
|
|
| 224 | 135 |
| |
| 225 | 136 |
|
| 226 | 137 |
=========================== ===================== |
| ... | ... | |
| 244 | 155 |
========================= ========= ================== |
| 245 | 156 |
Uri Method Description |
| 246 | 157 |
========================= ========= ================== |
| 247 |
``astakos/api/feedback`` POST Send feedback |
|
| 158 |
``/astakos/api/feedback`` POST Send feedback
|
|
| 248 | 159 |
========================= ========= ================== |
| 249 | 160 |
|
| 250 | 161 |
| |
| ... | ... | |
| 276 | 187 |
500 (Internal Server Error) The request cannot be completed because of an internal error |
| 277 | 188 |
=========================== ===================== |
| 278 | 189 |
|
| 190 |
.. warning:: The service is also available under ``/feedback``. |
|
| 191 |
It will be removed in the next version. |
|
| 192 |
|
|
| 279 | 193 |
Get User catalogs |
| 280 | 194 |
^^^^^^^^^^^^^^^^^ |
| 281 | 195 |
|
| ... | ... | |
| 284 | 198 |
================================ ========= ================== |
| 285 | 199 |
Uri Method Description |
| 286 | 200 |
================================ ========= ================== |
| 287 |
``astakos/api/user_catalogs`` POST Get 2 catalogs containing uuid to displayname mapping and the opposite |
|
| 201 |
``/astakos/api/user_catalogs`` POST Get 2 catalogs containing uuid to displayname mapping and the opposite
|
|
| 288 | 202 |
================================ ========= ================== |
| 289 | 203 |
|
| 290 | 204 |
| |
| ... | ... | |
| 327 | 241 |
500 (Internal Server Error) The request cannot be completed because of an internal error |
| 328 | 242 |
=========================== ===================== |
| 329 | 243 |
|
| 244 |
.. warning:: The service is also available under ``/user_catalogs``. |
|
| 245 |
It will be removed in the next version. |
|
| 246 |
|
|
| 330 | 247 |
Service API Operations |
| 331 | 248 |
---------------------- |
| 332 | 249 |
|
| ... | ... | |
| 342 | 259 |
===================================== ========= ================== |
| 343 | 260 |
Uri Method Description |
| 344 | 261 |
===================================== ========= ================== |
| 345 |
``astakos/api/service/user_catalogs`` POST Get 2 catalogs containing uuid to displayname mapping and the opposite |
|
| 262 |
``/astakos/api/service/user_catalogs`` POST Get 2 catalogs containing uuid to displayname mapping and the opposite
|
|
| 346 | 263 |
===================================== ========= ================== |
| 347 | 264 |
|
| 348 | 265 |
| |
| ... | ... | |
| 386 | 303 |
401 (Unauthorized) Missing or expired or invalid service token |
| 387 | 304 |
500 (Internal Server Error) The request cannot be completed because of an internal error |
| 388 | 305 |
=========================== ===================== |
| 306 |
|
|
| 307 |
.. warning:: The service is also available under ``/service/api/user_catalogs``. |
|
| 308 |
It will be removed in the next version. |
|
Also available in: Unified diff