.. -*- rst -*-

Hosts extension (os-hosts)
==========================

Administrators only, depending on policy settings.

Lists, shows hosts.


List all hosts for a project
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. rest_method::  GET /v3/{admin_project_id}/os-hosts

Lists all hosts summary info that is not disabled.

Response codes
--------------

.. rest_status_code:: success ../status.yaml

   - 200

.. rest_status_code:: error ../status.yaml

   - 400
   - 401
   - 403

Request
-------

.. rest_parameters:: parameters.yaml

   - admin_project_id: admin_project_id


Response Parameters
-------------------

.. rest_parameters:: parameters.yaml

   - hosts: hosts
   - service-status: host_service_status
   - service: host_service
   - zone: availability_zone_required
   - service-state: service_state
   - host_name: host_name_backend
   - last-update: updated_at

Response Example
----------------

.. literalinclude:: ./samples/hosts-list-response.json
   :language: javascript

Show Host Details for a project
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. rest_method:: GET /v3/{admin_project_id}/os-hosts/{host_name}

Shows volume and snapshot details for a cinder-volume host.

*Note:* This API is meant specifically for cinder-volume hosts only.
It is not valid against other Cinder service hosts or hosts where the
cinder-volume service has been disabled.

Response codes
--------------

.. rest_status_code:: success ../status.yaml

   - 200

.. rest_status_code:: error ../status.yaml

   - 400
   - 401
   - 403
   - 404

Request
-------

.. rest_parameters:: parameters.yaml

  - admin_project_id: admin_project_id
  - host_name: hostname

Response
--------

.. rest_parameters:: parameters.yaml

  - host: host
  - volume_count: total_count
  - total_volume_gb: totalGigabytesUsedStr
  - total_snapshot_gb: totalSnapGigabytesUsed
  - project: project_id_host
  - host: host_name_backend
  - snapshot_count: totalSnapshotsUsed

Response Example
----------------

.. literalinclude:: ./samples/hosts-get-response.json
   :language: javascript