Kevin_Zheng
f774d03b6f
This patch fix API ref for correct sample files and status code for below APIs - os-cells - os-cloudpipe - server-action-shelve Part of bp:api-ref-in-rst Change-Id: I6292f78742d7bb50882e186c97e7966721037ba4
120 lines
2.5 KiB
ReStructuredText
120 lines
2.5 KiB
ReStructuredText
.. -*- rst -*-
|
|
|
|
==============================
|
|
Cells (os-cells, capacities)
|
|
==============================
|
|
|
|
Adds neighbor cells, lists neighbor cells, and shows the capabilities of
|
|
the local cell.
|
|
|
|
List Cells
|
|
==========
|
|
|
|
.. rest_method:: GET /v2.1/{tenant_id}/os-cells
|
|
|
|
Lists cells.
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400),
|
|
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404), NotImplemented(501)
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- tenant_id: tenant_id
|
|
|
|
Response
|
|
--------
|
|
|
|
**Example List Cells: JSON request**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/os-cells/cells-list-resp.json
|
|
:language: javascript
|
|
|
|
List Cells With Details
|
|
=======================
|
|
|
|
.. rest_method:: GET /v2.1/{tenant_id}/os-cells
|
|
|
|
Lists cells with details.
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400),
|
|
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404), NotImplemented(501)
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- tenant_id: tenant_id
|
|
|
|
Response
|
|
--------
|
|
|
|
**Example List Cells With Details: JSON request**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/os-cells/cells-list-empty-resp.json
|
|
:language: javascript
|
|
|
|
Show Cell Data
|
|
==============
|
|
|
|
.. rest_method:: GET /v2.1/{tenant_id}/os-cells/{cell_id}
|
|
|
|
Shows data for a cell.
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400),
|
|
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404), NotImplemented(501)
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- tenant_id: tenant_id
|
|
- cell_id: cell_id
|
|
|
|
Response
|
|
--------
|
|
|
|
**Example Show Cell Data: JSON request**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/os-cells/cells-get-resp.json
|
|
:language: javascript
|
|
|
|
Show Cell Capacities
|
|
====================
|
|
|
|
.. rest_method:: GET /v2.1/{tenant_id}/os-cells/{cell_id}/capacities
|
|
|
|
Shows capacities for a cell.
|
|
|
|
Normal response codes: 200,501
|
|
|
|
Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400),
|
|
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404), NotImplemented(501)
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- tenant_id: tenant_id
|
|
- cell_id: cell_id
|
|
|
|
Response
|
|
--------
|
|
|
|
**Example Show Cell Capacities: JSON request**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/os-cells/cells-capacities-resp.json
|
|
:language: javascript
|
|
|