bf219ebf8f
Add details for mservices API of Magnum. Implements: blueprint magnum-doc-rest-api Change-Id: I2beba238e12fd6f23a10a1a6b14d1fce0f5066cf
49 lines
1.0 KiB
ReStructuredText
49 lines
1.0 KiB
ReStructuredText
.. -*- rst -*-
|
|
|
|
=====================
|
|
Manage Magnum service
|
|
=====================
|
|
|
|
Show container infrastructure management service status
|
|
=======================================================
|
|
|
|
.. rest_method:: GET /v1/mservices
|
|
|
|
Enables administrative users to view details for all Magnum services.
|
|
|
|
Container infrastructure service status details 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 |