Files
9569bc3552f4ae2df5f7e063ab8b09b20103e61c
nova /api-ref /source /os-hosts.inc

212 lines
4.1 KiB
PHP
Raw Normal View History

==================
Hosts (os-hosts)
==================
matrix <http://docs.openstack.org/developer/nova/support-matrix.html>`__
all os-hosts related operations. Cloud providers can change these permissions
through the ``policy.json`` file.
==========
Lists hosts.
Normal response codes: 200
Response
- hosts: hosts
- zone: host_zone
- host_name: host_name_body
- service: host_service
**Example List Hosts**
.. literalinclude:: ../../doc/api_samples/os-hosts/hosts-list-resp.json
:language: javascript
=================
Normal response codes: 200
Request
.. rest_parameters:: parameters.yaml
- host_name: host_name
Response
- host: host_resource_array
- resource: host_resource
- resource.cpu: host_cpu
- resource.memory_mb: host_memory_mb
- resource.disk_gb: host_disk_gb
- resource.host: host_name_body
**Example Show Host Details**
==================
Normal response codes: 200
itemNotFound(404), NotImplemented(501)
Request
.. rest_parameters:: parameters.yaml
- host_name: host_name
- maintenance_mode: host_maintenance_mode_in
.. literalinclude:: ../../doc/api_samples/os-hosts/host-put-maintenance-req.json
:language: javascript
- host: host_name_body
**Example Enable Host**
Reboot Host
===========
Reboots a host.
Normal response codes: 200
itemNotFound(404), NotImplemented(501)
Request
.. rest_parameters:: parameters.yaml
- host_name: host_name
Response
- host: host_name_body
- power_action: host_power_action
Shut Down Host
==============
Shuts down a host.
Normal response codes: 200
itemNotFound(404), NotImplemented(501)
Request
.. rest_parameters:: parameters.yaml
- host_name: host_name
Response
- host: host_name_body
- power_action: host_power_action
**Example Shut Down Host**
Start Host
==========
Starts a host.
Normal response codes: 200
itemNotFound(404), NotImplemented(501)
Request
.. rest_parameters:: parameters.yaml
- host_name: host_name
Response
- host: host_name_body
- power_action: host_power_action
**Example Start Host**