609412fcd2
The parameters with name like example_1, example_2 ... etc. cause confusion while updating the api-ref docs like the examples below: https://review.openstack.org/#/c/609639/ https://review.openstack.org/#/c/609611/ This patch does the following changes : 1) Replace numbering in the parameter with relevant names 2) Clean up unused parameters Change-Id: I35b343bf068281d729576e5ecc209bda60c28680
109 lines
2.0 KiB
ReStructuredText
109 lines
2.0 KiB
ReStructuredText
.. -*- 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: 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: totalGigabytesUsed
|
|
- 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
|