zun/api-ref/source/hosts.inc
miaohb d8c66a8be3 Fix error in api-ref about host
This patch adds the missing parameter "host_list" in api-ref.

Change-Id: I9dab7333b386675a2d9ae80c17f21e1f970a28c2
Closes-Bug: #1712466
2017-08-22 21:12:25 -07:00

81 lines
1.2 KiB
ReStructuredText

.. -*- rst -*-
==================
Manage zun host
==================
List all compute hosts
========================================
.. rest_method:: GET /v1/hosts
Enables administrative users to list all Zun container hosts.
Response Codes
--------------
.. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- X-Openstack-Request-Id: request_id
- hosts: host_list
Response Example
----------------
.. literalinclude:: samples/host-get-all-resp.json
:language: javascript
Show details of a host
===========================
.. rest_method:: GET /v1/hosts/{host_ident}
Get all information of a host in Zun.
Response Codes
--------------
.. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: error status.yaml
- 401
- 403
- 404
Request
-------
.. rest_parameters:: parameters.yaml
- host_ident: host_ident
Response
--------
.. rest_parameters:: parameters.yaml
- uuid: uuid
- hostname: hostname
Response Example
----------------
.. literalinclude:: samples/host-get-resp.json
:language: javascript