1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194
|
.. -*- rst -*-
==============================
Cells (os-cells, capacities)
==============================
Adds neighbor cells, lists neighbor cells, and shows the capabilities of
the local cell. By default, only administrators can manage cells.
.. warning::
These APIs refer to a Cells v1 deployment which was deprecated in the 16.0.0
Pike release. These are not used with Cells v2 which is required beginning
with the 15.0.0 Ocata release where all Nova deployments consist of at least
one Cells v2 cell.
They were removed in the 20.0.0 Train release.
List Cells
==========
.. rest_method:: GET /os-cells
Lists cells.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
gone(410), notImplemented(501)
Request
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- limit: limit_simple
- offset: offset_simple
Response
--------
**Example List Cells: JSON response**
.. literalinclude:: ../../doc/api_samples/os-cells/cells-list-resp.json
:language: javascript
Create Cell
===========
.. rest_method:: POST /os-cells
Create a new cell.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
gone(410), notImplemented(501)
Capacities
==========
.. rest_method:: GET /os-cells/capacities
Retrieve capacities.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
gone(410), notImplemented(501)
List Cells With Details
=======================
.. rest_method:: GET /os-cells/detail
Lists cells with details of capabilities.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
gone(410), notImplemented(501)
Request
-------
.. rest_parameters:: parameters.yaml
- limit: limit_simple
- offset: offset_simple
Info For This Cell
==================
.. rest_method:: GET /os-cells/info
Retrieve info about the current cell.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
gone(410), notImplemented(501)
Show Cell Data
==============
.. rest_method:: GET /os-cells/{cell_id}
Shows data for a cell.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404), gone(410), notImplemented(501)
Request
-------
.. rest_parameters:: parameters.yaml
- cell_id: cell_id
Response
--------
**Example Show Cell Data: JSON response**
.. literalinclude:: ../../doc/api_samples/os-cells/cells-get-resp.json
:language: javascript
Update a Cell
=============
.. rest_method:: PUT /os-cells/{cell_id}
Update an existing cell.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404), gone(410), notImplemented(501)
Request
-------
.. rest_parameters:: parameters.yaml
- cell_id: cell_id
Delete a Cell
=============
.. rest_method:: DELETE /os-cells/{cell_id}
Remove a cell.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404), gone(410), notImplemented(501)
Request
-------
.. rest_parameters:: parameters.yaml
- cell_id: cell_id
Show Cell Capacities
====================
.. rest_method:: GET /os-cells/{cell_id}/capacities
Shows capacities for a cell.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404), gone(410), notImplemented(501)
Request
-------
.. rest_parameters:: parameters.yaml
- cell_id: cell_id
Response
--------
**Example Show Cell Capacities: JSON response**
.. literalinclude:: ../../doc/api_samples/os-cells/cells-capacities-resp.json
:language: javascript
|