magnum/api-ref/source/mservices.inc
coldmoment 0293e75bf3 Update the 'service-list' api-ref
Change-Id: I4d7a2b537425c008592b6d1bfa675d17c600e004
2017-06-05 16:11:19 +08:00

50 lines
1.0 KiB
ReStructuredText

.. -*- rst -*-
=====================
Manage Magnum service
=====================
List container infrastructure management services
=======================================================
.. rest_method:: GET /v1/mservices
Enables administrative users to list all Magnum services.
Container infrastructure service information include service id, binary,
host, report count, creation time, last updated time, health status, and
the reason for disabling service.
Response Codes
--------------
.. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: error status.yaml
- 401
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- X-Openstack-Request-Id: request_id
- mservices: mservices
- binary: binary
- created_at: created_at
- state: state
- report_count: report_count
- updated_at: updated_at
- host: host
- disabled_reason: disabled_reason
- id: id_s
Response Example
----------------
.. literalinclude:: samples/mservice-get-resp.json
:language: javascript