c9f5ad3bcf
As discussed at summit, the version part of the URL is not really relevant, or a thing a user should be filling out themselves, this should instead be set by the service catalog and extracted from the token. This removes it's reference in all documented REST urls, and adds a new section describing how one gets the base URL for all calls. Change-Id: I4306b8c3de0225e54f3909dd8a1fb293c4e5944c
192 lines
4.7 KiB
ReStructuredText
192 lines
4.7 KiB
ReStructuredText
.. -*- rst -*-
|
|
.. needs:parameter_verification
|
|
.. needs:example_verification
|
|
.. needs:body_verification
|
|
|
|
==============================
|
|
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 /os-hypervisors
|
|
|
|
Lists hypervisors.
|
|
|
|
Policy defaults enable only users with the administrative role to perform this operation. Cloud providers can change these permissions through the ``policy.json`` file.
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes: unauthorized(401), forbidden(403)
|
|
|
|
Response
|
|
--------
|
|
|
|
**Example List Hypervisors: JSON response**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/os-hypervisors/hypervisors-list-resp.json
|
|
:language: javascript
|
|
|
|
List Hypervisors Details
|
|
========================
|
|
|
|
.. rest_method:: GET /os-hypervisors/detail
|
|
|
|
Lists hypervisors details.
|
|
|
|
Policy defaults enable only users with the administrative role to perform this operation. Cloud providers can change these permissions through the ``policy.json`` file.
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes: unauthorized(401), forbidden(403)
|
|
|
|
Response
|
|
--------
|
|
|
|
**Example List Hypervisors Details: JSON request**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/os-hypervisors/hypervisors-detail-resp.json
|
|
:language: javascript
|
|
|
|
Show Hypervisor Statistics
|
|
==========================
|
|
|
|
.. rest_method:: GET /os-hypervisors/statistics
|
|
|
|
Shows summary statistics for all hypervisors over all compute nodes.
|
|
|
|
Policy defaults enable only users with the administrative role to perform this operation. Cloud providers can change these permissions through the ``policy.json`` file.
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes: unauthorized(401), forbidden(403)
|
|
|
|
Response
|
|
--------
|
|
|
|
**Example Show Hypervisor Statistics: JSON response**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/os-hypervisors/hypervisors-statistics-resp.json
|
|
:language: javascript
|
|
|
|
Show Hypervisor Details
|
|
=======================
|
|
|
|
.. rest_method:: GET /os-hypervisors/{hypervisor_id}
|
|
|
|
Shows details for a hypervisor.
|
|
|
|
Policy defaults enable only users with the administrative role to perform this operation. Cloud providers can change these permissions thro
|
|
ugh the ``policy.json`` file.
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- hypervisor_id: hypervisor_id
|
|
|
|
Response
|
|
--------
|
|
|
|
**Example Show Hypervisor Details: JSON response**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/os-hypervisors/hypervisors-show-resp.json
|
|
:language: javascript
|
|
|
|
Show Hypervisor Uptime
|
|
======================
|
|
|
|
.. rest_method:: GET /os-hypervisors/{hypervisor_id}/uptime
|
|
|
|
Shows the uptime for a hypervisor.
|
|
|
|
Policy defaults enable only users with the administrative role to perform this operation. Cloud providers can change these permissions thro
|
|
ugh the ``policy.json`` file.
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404), NotImplemented(501)
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- hypervisor_id: hypervisor_id
|
|
|
|
Response
|
|
--------
|
|
|
|
**Example Show Hypervisor Uptime: JSON response**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/os-hypervisors/hypervisors-uptime-resp.json
|
|
:language: javascript
|
|
|
|
Search Hypervisor
|
|
=================
|
|
|
|
.. rest_method:: GET /os-hypervisors/{hypervisor_id}/search
|
|
|
|
Search hypervisor by given hypervisor id.
|
|
|
|
Policy defaults enable only users with the administrative role to perform this operation. Cloud providers can change these permissions thro
|
|
ugh the ``policy.json`` file.
|
|
|
|
Normal response code: 200
|
|
|
|
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- hypervisor_id: hypervisor_id
|
|
|
|
Response
|
|
--------
|
|
|
|
**Example Search Hypervisor: JSON request**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/os-hypervisors/hypervisors-search-resp.json
|
|
:language: javascript
|
|
|
|
List Hypervisor Servers
|
|
=======================
|
|
|
|
.. rest_method:: GET /os-hypervisors/{hypervisor_id}/servers
|
|
|
|
List all servers belong to given hypervisor.
|
|
|
|
Policy defaults enable only users with the administrative role to perform this operation. Cloud providers can change these permissions thro
|
|
ugh the ``policy.json`` file.
|
|
|
|
Normal response code: 200
|
|
|
|
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- hypervisor_id: hypervisor_id
|
|
|
|
Response
|
|
--------
|
|
|
|
**Example List Hypervisor Servers: JSON request**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/os-hypervisors/hypervisors-with-servers-resp.json
|
|
:language: javascript
|