api-site/api-ref/source/orchestration/v1/service-status.inc
Anne Gentle ac4cc65cb5 Adds migrated RST + YAML files from WADL
Contains .inc files which have all the contents of the .rst files
but are grouped together for easier editing.
Contains parameters.yaml, which has all parameters in one file.
Contains request and response samples (JSON and XML) that are
pointed to from the .inc files.

Change-Id: I42d5451300f95774a3ec4df66bc95cb36795844d
2016-05-02 17:42:49 -05:00

68 lines
1.2 KiB
ReStructuredText

.. -*- rst -*-
==============
Manage service
==============
Show orchestration engine status
================================
.. rest_method:: GET /v1/{tenant_id}/services
Enables administrative users to view details for all orchestration engines.
Orchestration engine details include ``engine_id``, topic name,
last updated time, health status, and host name.
Troubleshooting
- A ``503`` error code indicates that the heat engines are not
operational. Run the heat-manage service list command or contact
your cloud provider to determine why the heat engines are not
operational.
Normal response codes: 200
Error response codes:403,503,
Request
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- status: status
- binary: binary
- report_interval: report_interval
- created_at: created_at
- hostname: hostname
- updated_at: updated_at
- topic: topic
- services: services
- deleted_at: deleted_at
- id: id
Response Example
----------------
.. literalinclude:: samples/services-list-response.json
:language: javascript