d4e2771440
This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
121 lines
2.7 KiB
ReStructuredText
121 lines
2.7 KiB
ReStructuredText
.. -*- rst -*-
|
|
|
|
==============================
|
|
Hypervisors (os-hypervisors)
|
|
==============================
|
|
|
|
Lists all hypervisors, shows summary statistics for all hypervisors over
|
|
all compute nodes, shows details for a hypervisor, and shows the uptime
|
|
for a hypervisor.
|
|
|
|
List Hypervisors
|
|
================
|
|
|
|
.. rest_method:: GET /v2.1/{tenant_id}/os-hypervisors
|
|
|
|
Lists hypervisors.
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400),
|
|
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
|
|
|
|
Request
|
|
^^^^^^^
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- tenant_id: tenant_id
|
|
|
|
Response
|
|
^^^^^^^^
|
|
|
|
**Example List Hypervisors: JSON request**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/os-hypervisors/hypervisors-list-resp.json
|
|
:language: javascript
|
|
|
|
Show Hypervisor Statistics
|
|
==========================
|
|
|
|
.. rest_method:: GET /v2.1/{tenant_id}/os-hypervisors/statistics
|
|
|
|
Shows summary statistics for all hypervisors over all compute nodes.
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400),
|
|
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
|
|
|
|
Request
|
|
^^^^^^^
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- tenant_id: tenant_id
|
|
|
|
Response
|
|
^^^^^^^^
|
|
|
|
**Example Show Hypervisor Statistics: JSON request**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/os-hypervisors/hypervisor-statistics-show-resp.json
|
|
:language: javascript
|
|
|
|
Show Hypervisor Details
|
|
=======================
|
|
|
|
.. rest_method:: GET /v2.1/{tenant_id}/os-hypervisors/{hypervisor_id}
|
|
|
|
Shows details for a hypervisor.
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400),
|
|
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
|
|
|
|
Request
|
|
^^^^^^^
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- tenant_id: tenant_id
|
|
- hypervisor_id: hypervisor_id
|
|
|
|
Response
|
|
^^^^^^^^
|
|
|
|
**Example Show Hypervisor Details: JSON request**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/os-hypervisors/hypervisor-show-resp.json
|
|
:language: javascript
|
|
|
|
Show Hypervisor Uptime
|
|
======================
|
|
|
|
.. rest_method:: GET /v2.1/{tenant_id}/os-hypervisors/{hypervisor_id}/uptime
|
|
|
|
Shows the uptime for a hypervisor.
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400),
|
|
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
|
|
|
|
Request
|
|
^^^^^^^
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- tenant_id: tenant_id
|
|
- hypervisor_id: hypervisor_id
|
|
|
|
Response
|
|
^^^^^^^^
|
|
|
|
**Example Show Hypervisor Uptime: JSON request**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/os-hypervisors/hypervisor-uptime-show-resp.json
|
|
:language: javascript
|
|
|